From 643f53368e224eeaa7e26c13db4a6f92bdb0d839 Mon Sep 17 00:00:00 2001 From: Ann Priestman Date: Tue, 17 Sep 2019 14:38:58 -0400 Subject: [PATCH] Doxygen fixes --- .../autopsy/casemodule/services/Services.java | 2 +- .../autopsy/coreutils/AppDBParserHelper.java | 14 +++++++------- .../sleuthkit/autopsy/coreutils/AppSQLiteDB.java | 6 +++--- .../org/sleuthkit/autopsy/coreutils/ExecUtil.java | 2 +- .../report/caseuco/CaseUcoFormatExporter.java | 4 ++-- .../autopsy/timeline/actions/AddManualEvent.java | 1 + .../ui/detailview/datamodel/DetailsViewModel.java | 1 + .../filtering/datamodel/CompoundFilterState.java | 2 -- .../ui/listvew/datamodel/CombinedEvent.java | 1 - .../autopsy/timeline/utils/TimelineDBUtils.java | 2 +- .../ThunderbirdMboxFileIngestModule.java | 2 +- 11 files changed, 18 insertions(+), 19 deletions(-) diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/services/Services.java b/Core/src/org/sleuthkit/autopsy/casemodule/services/Services.java index 02f98f2887..81bc6a643c 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/services/Services.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/services/Services.java @@ -80,7 +80,7 @@ public class Services implements Closeable { /** * Gets the artifacts blackboard for the current case. * - * @return @org.sleuthkit.datamodel.Blackboard Blackboard for the current + * @return org.sleuthkit.datamodel.Blackboard Blackboard for the current * case. */ public org.sleuthkit.datamodel.Blackboard getArtifactsBlackboard() { diff --git a/Core/src/org/sleuthkit/autopsy/coreutils/AppDBParserHelper.java b/Core/src/org/sleuthkit/autopsy/coreutils/AppDBParserHelper.java index 538ea07098..01771f0581 100644 --- a/Core/src/org/sleuthkit/autopsy/coreutils/AppDBParserHelper.java +++ b/Core/src/org/sleuthkit/autopsy/coreutils/AppDBParserHelper.java @@ -283,8 +283,8 @@ public final class AppDBParserHelper { /** * Adds a relations between the two specified account instances. * - * @param selfAccount device owner account - * @param otherAccount other account + * @param selfAccountInstance device owner account + * @param otherAccountInstance other account * @param sourceArtifact artifact from which relationship is derived. * @param relationshipType type of relationship * @param dateTime date/time of relationship @@ -316,7 +316,7 @@ public final class AppDBParserHelper { * @param readStatus message read or not * @param subject message subject, may be empty * @param messageText message body, may be empty - * @param threadId, message thread id + * @param threadId message thread id * * @return message artifact */ @@ -347,7 +347,7 @@ public final class AppDBParserHelper { * @param readStatus message read or not * @param subject message subject, may be empty * @param messageText message body, may be empty - * @param threadId, message thread id + * @param threadId message thread id * * @param otherAttributesList additional attributes * @@ -385,7 +385,7 @@ public final class AppDBParserHelper { * @param readStatus message read or not * @param subject message subject, may be empty * @param messageText message body, may be empty - * @param threadId, message thread id + * @param threadId message thread id * * * @return message artifact @@ -867,7 +867,7 @@ public final class AppDBParserHelper { * @param accessTime last access time * @param referrer referrer, may be empty * @param title website title, may be empty - * @param programName, application recording the history + * @param programName application recording the history * * @return artifact created */ @@ -884,7 +884,7 @@ public final class AppDBParserHelper { * @param accessTime last access time * @param referrer referrer, may be empty * @param title website title, may be empty - * @param programName, application recording the history + * @param programName application recording the history * @param otherAttributesList other attributes * * diff --git a/Core/src/org/sleuthkit/autopsy/coreutils/AppSQLiteDB.java b/Core/src/org/sleuthkit/autopsy/coreutils/AppSQLiteDB.java index 6812f6daf3..bb8a1ed227 100644 --- a/Core/src/org/sleuthkit/autopsy/coreutils/AppSQLiteDB.java +++ b/Core/src/org/sleuthkit/autopsy/coreutils/AppSQLiteDB.java @@ -95,8 +95,8 @@ public final class AppSQLiteDB implements Closeable { * AppSQLiteDB to help query the DB. * * A list of AppSQLiteDB instances is returned, one for each - * match found., - * . + * match found. + * * @param dataSource data source to search in * @param dbName db file name to search * @param matchExactName whether to look for exact file name or a pattern match @@ -174,7 +174,7 @@ public final class AppSQLiteDB implements Closeable { * @param dbName db file name to search * @param matchExactName whether to look for exact file name or a pattern match * @param dbPath path to match - * @param matchExactName whether to look for exact path name or a substring match + * @param matchExactPath whether to look for exact path name or a substring match * * @return a collection of AppSQLiteDBFileBundle * diff --git a/Core/src/org/sleuthkit/autopsy/coreutils/ExecUtil.java b/Core/src/org/sleuthkit/autopsy/coreutils/ExecUtil.java index 9a211c57a0..022b507212 100644 --- a/Core/src/org/sleuthkit/autopsy/coreutils/ExecUtil.java +++ b/Core/src/org/sleuthkit/autopsy/coreutils/ExecUtil.java @@ -206,7 +206,7 @@ public final class ExecUtil { * @param terminator The ProcessTerminator used to determine if the process * should be killed. * - * @returnthe exit value of the process + * @return the exit value of the process * * @throws SecurityException if a security manager exists and vetoes any * aspect of running the process. diff --git a/Core/src/org/sleuthkit/autopsy/report/caseuco/CaseUcoFormatExporter.java b/Core/src/org/sleuthkit/autopsy/report/caseuco/CaseUcoFormatExporter.java index 03bffed89d..d3ab17ffe9 100755 --- a/Core/src/org/sleuthkit/autopsy/report/caseuco/CaseUcoFormatExporter.java +++ b/Core/src/org/sleuthkit/autopsy/report/caseuco/CaseUcoFormatExporter.java @@ -198,7 +198,7 @@ public final class CaseUcoFormatExporter { } /** - * Exports files that are tagged w/ the following TagNames and that belong to + * Exports files that are tagged with the following TagNames and that belong to * the following interesting file sets (set name attributes of TSK_INTERSTING_FILE_HIT * and TSK_INTERESTING_ARTIFACT_HIT). Artifacts that are tagged with * the following TagNames also have their associated source files included. @@ -208,7 +208,7 @@ public final class CaseUcoFormatExporter { * @param tagTypes Collection of TagNames to match * @param interestingItemSets Collection of SET_NAMEs to match on in TSK_INTERESTING_FILE_HITs * and TSK_INTERESTING_ARTIFACT_HITs. - * @param outputFilePath Path to the folder that the CASE-UCO report should be written into + * @param caseReportFolder Path to the folder that the CASE-UCO report should be written into * @param progressPanel UI Component to be updated with current processing status */ @NbBundle.Messages({ diff --git a/Core/src/org/sleuthkit/autopsy/timeline/actions/AddManualEvent.java b/Core/src/org/sleuthkit/autopsy/timeline/actions/AddManualEvent.java index 5d02925db9..33220b173a 100755 --- a/Core/src/org/sleuthkit/autopsy/timeline/actions/AddManualEvent.java +++ b/Core/src/org/sleuthkit/autopsy/timeline/actions/AddManualEvent.java @@ -127,6 +127,7 @@ public class AddManualEvent extends Action { * Use the supplied ManualEventInfo to make an TSK_TL_EVENT artifact which * will trigger adding a TimelineEvent. * + * @param controller * @param eventInfo The ManualEventInfo with the info needed to create an * event. * diff --git a/Core/src/org/sleuthkit/autopsy/timeline/ui/detailview/datamodel/DetailsViewModel.java b/Core/src/org/sleuthkit/autopsy/timeline/ui/detailview/datamodel/DetailsViewModel.java index 8bb257867c..f37cce6035 100755 --- a/Core/src/org/sleuthkit/autopsy/timeline/ui/detailview/datamodel/DetailsViewModel.java +++ b/Core/src/org/sleuthkit/autopsy/timeline/ui/detailview/datamodel/DetailsViewModel.java @@ -102,6 +102,7 @@ final public class DetailsViewModel { } /** + * @param uiFilter * @param zoom * * @return a list of aggregated events that are within the requested time diff --git a/Core/src/org/sleuthkit/autopsy/timeline/ui/filtering/datamodel/CompoundFilterState.java b/Core/src/org/sleuthkit/autopsy/timeline/ui/filtering/datamodel/CompoundFilterState.java index 6723242141..e85fabe4da 100755 --- a/Core/src/org/sleuthkit/autopsy/timeline/ui/filtering/datamodel/CompoundFilterState.java +++ b/Core/src/org/sleuthkit/autopsy/timeline/ui/filtering/datamodel/CompoundFilterState.java @@ -121,8 +121,6 @@ public class CompoundFilterState eventMap) { diff --git a/Core/src/org/sleuthkit/autopsy/timeline/utils/TimelineDBUtils.java b/Core/src/org/sleuthkit/autopsy/timeline/utils/TimelineDBUtils.java index 5c67852ae5..5fde45aa13 100755 --- a/Core/src/org/sleuthkit/autopsy/timeline/utils/TimelineDBUtils.java +++ b/Core/src/org/sleuthkit/autopsy/timeline/utils/TimelineDBUtils.java @@ -63,7 +63,7 @@ public class TimelineDBUtils { * into a set of X using the mapper to convert from string to X. If * groupConcat is empty, null, or all whitespace, returns an empty list. * - * @param the type of elements to return + * X the type of elements to return * @param groupConcat a string containing the group_concat result ( a comma * separated list) * @param mapper a function from String to X diff --git a/thunderbirdparser/src/org/sleuthkit/autopsy/thunderbirdparser/ThunderbirdMboxFileIngestModule.java b/thunderbirdparser/src/org/sleuthkit/autopsy/thunderbirdparser/ThunderbirdMboxFileIngestModule.java index f428b455cf..3f1daa1a1c 100644 --- a/thunderbirdparser/src/org/sleuthkit/autopsy/thunderbirdparser/ThunderbirdMboxFileIngestModule.java +++ b/thunderbirdparser/src/org/sleuthkit/autopsy/thunderbirdparser/ThunderbirdMboxFileIngestModule.java @@ -411,7 +411,7 @@ public final class ThunderbirdMboxFileIngestModule implements FileIngestModule { * appropriate artifacts and derived files. * * @param partialEmailsForThreading - * @param fileMessageIterator + * @param fullMessageIterator * @param abstractFile */ private void processEmails(List partialEmailsForThreading, Iterator fullMessageIterator, AbstractFile abstractFile) {