From 548ac6675df2c33eb2ec30b07acd0ba1f6782e15 Mon Sep 17 00:00:00 2001 From: apriestman Date: Mon, 1 Jun 2020 13:54:01 -0400 Subject: [PATCH] Doxygen fixes --- Core/src/org/sleuthkit/autopsy/actions/ReplaceTagAction.java | 4 ++++ Core/src/org/sleuthkit/autopsy/casemodule/Case.java | 1 + .../casemodule/events/BlackBoardArtifactTagDeletedEvent.java | 2 +- .../autopsy/casemodule/events/ContentTagDeletedEvent.java | 2 +- .../autopsy/centralrepository/datamodel/Persona.java | 3 +-- .../autopsy/geolocation/datamodel/WaypointBuilder.java | 2 +- .../src/org/sleuthkit/autopsy/guiutils/CheckBoxListPanel.java | 1 + .../autopsy/modules/hashdatabase/HashDbIngestModule.java | 1 + .../autopsy/report/modules/caseuco/CaseUcoReportModule.java | 2 +- .../autopsy/report/modules/stix/STIXReportModule.java | 2 +- 10 files changed, 13 insertions(+), 7 deletions(-) diff --git a/Core/src/org/sleuthkit/autopsy/actions/ReplaceTagAction.java b/Core/src/org/sleuthkit/autopsy/actions/ReplaceTagAction.java index 09d5d5ba6b..91929db577 100644 --- a/Core/src/org/sleuthkit/autopsy/actions/ReplaceTagAction.java +++ b/Core/src/org/sleuthkit/autopsy/actions/ReplaceTagAction.java @@ -199,6 +199,8 @@ abstract class ReplaceTagAction extends AbstractAction implements * Build a JMenu for the given TagSet. * * @param tagSet + * @param tagNamesToDisable + * @param selectedTags * * @return JMenu for the given TagSet */ @@ -217,6 +219,8 @@ abstract class ReplaceTagAction extends AbstractAction implements * Create a menu item for the given TagName. * * @param tagName TagName from which to create the menu item. + * @param tagNamesToDisable + * @param selectedTags * * @return Menu item for given TagName. */ diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java index 7cd1738524..1ddfb6e89b 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java @@ -2506,6 +2506,7 @@ public class Case { * specific to this case. * * @param progressIndicator A progress indicator. + * @param isNewCase True if case is new * * @throws CaseActionException If there is a problem completing the * operation. The exception will have a diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/BlackBoardArtifactTagDeletedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/BlackBoardArtifactTagDeletedEvent.java index 96da9e1aec..69bfbe299c 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/BlackBoardArtifactTagDeletedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/BlackBoardArtifactTagDeletedEvent.java @@ -46,7 +46,7 @@ public class BlackBoardArtifactTagDeletedEvent extends TagDeletedEvent implemen } /** - * Extension of {@link DeletedTagInfo} for BlackBoardArtifactTags that + * Extension of DeletedTagInfo for BlackBoardArtifactTags that * includes byte offset related info. */ @Immutable diff --git a/Core/src/org/sleuthkit/autopsy/centralrepository/datamodel/Persona.java b/Core/src/org/sleuthkit/autopsy/centralrepository/datamodel/Persona.java index 2c48021400..e0a6577e8f 100644 --- a/Core/src/org/sleuthkit/autopsy/centralrepository/datamodel/Persona.java +++ b/Core/src/org/sleuthkit/autopsy/centralrepository/datamodel/Persona.java @@ -258,7 +258,6 @@ public class Persona { * Associates an account with a persona by creating a row in the * PersonaAccounts table. * - * @param persona Persona to add the account to. * @param account Account to add to persona. * @param justification Reason for adding the account to persona, may be * null. @@ -658,7 +657,7 @@ public class Persona { /** * Get all the persona for a given data source. * - * @param CorrelationDataSource Data source to look the persona in. + * @param dataSource Data source to look the persona in. * * @return Collection of personas, may be empty. * @throws CentralRepoException diff --git a/Core/src/org/sleuthkit/autopsy/geolocation/datamodel/WaypointBuilder.java b/Core/src/org/sleuthkit/autopsy/geolocation/datamodel/WaypointBuilder.java index 11ff0107dd..cf414a2fdc 100755 --- a/Core/src/org/sleuthkit/autopsy/geolocation/datamodel/WaypointBuilder.java +++ b/Core/src/org/sleuthkit/autopsy/geolocation/datamodel/WaypointBuilder.java @@ -96,7 +96,7 @@ public final class WaypointBuilder { /** * This function will be called after the waypoints have been filtered. * - * @param wwaypoints This of waypoints. + * @param waypoints The list of waypoints. */ void process(List waypoints); } diff --git a/Core/src/org/sleuthkit/autopsy/guiutils/CheckBoxListPanel.java b/Core/src/org/sleuthkit/autopsy/guiutils/CheckBoxListPanel.java index 775c99eb77..ecb6c2e78c 100755 --- a/Core/src/org/sleuthkit/autopsy/guiutils/CheckBoxListPanel.java +++ b/Core/src/org/sleuthkit/autopsy/guiutils/CheckBoxListPanel.java @@ -50,6 +50,7 @@ public final class CheckBoxListPanel extends javax.swing.JPanel { * Add a new element to the check box list. * * @param displayName display name for the checkbox + * @param icon * @param obj Object that the checkbox represents */ public void addElement(String displayName, Icon icon, T obj) { diff --git a/Core/src/org/sleuthkit/autopsy/modules/hashdatabase/HashDbIngestModule.java b/Core/src/org/sleuthkit/autopsy/modules/hashdatabase/HashDbIngestModule.java index 873f891ad0..7c69fa02cc 100644 --- a/Core/src/org/sleuthkit/autopsy/modules/hashdatabase/HashDbIngestModule.java +++ b/Core/src/org/sleuthkit/autopsy/modules/hashdatabase/HashDbIngestModule.java @@ -590,6 +590,7 @@ public class HashDbIngestModule implements FileIngestModule { * * @param jobId The ID of the job. * @param knownBadHashSets The list of hash sets for "known bad" files. + * @param noChangeHashSets The list of "no change" hash sets. * @param knownHashSets The list of hash sets for "known" files. */ @Messages("HashDbIngestModule.complete.noChangesFound=No Change items found:") diff --git a/Core/src/org/sleuthkit/autopsy/report/modules/caseuco/CaseUcoReportModule.java b/Core/src/org/sleuthkit/autopsy/report/modules/caseuco/CaseUcoReportModule.java index 3b9c7232d3..d90b4a54c2 100755 --- a/Core/src/org/sleuthkit/autopsy/report/modules/caseuco/CaseUcoReportModule.java +++ b/Core/src/org/sleuthkit/autopsy/report/modules/caseuco/CaseUcoReportModule.java @@ -109,7 +109,7 @@ public final class CaseUcoReportModule implements GeneralReportModule { /** * Generates a CASE-UCO format report for all files in the Case. * - * @param baseReportDir caseDirPath to save the report + * @param settings Report settings. * @param progressPanel panel to update the report's progress */ @NbBundle.Messages({ diff --git a/Core/src/org/sleuthkit/autopsy/report/modules/stix/STIXReportModule.java b/Core/src/org/sleuthkit/autopsy/report/modules/stix/STIXReportModule.java index 365f37a02d..e300171cf1 100644 --- a/Core/src/org/sleuthkit/autopsy/report/modules/stix/STIXReportModule.java +++ b/Core/src/org/sleuthkit/autopsy/report/modules/stix/STIXReportModule.java @@ -93,7 +93,7 @@ public class STIXReportModule implements GeneralReportModule { } /** - * @param baseReportDir path to save the report + * @param settings Report settings. * @param progressPanel panel to update the report's progress */ @Override