From d19e1eddaf47e88e43925bd12d8909a4c3d53e3e Mon Sep 17 00:00:00 2001 From: apriestman Date: Fri, 8 Jan 2021 08:45:41 -0500 Subject: [PATCH] Doxygen fixes --- .../sleuthkit/autopsy/communications/CVTPersonaCache.java | 4 ++-- .../artifactviewers/GeneralPurposeArtifactViewer.java | 2 +- .../org/sleuthkit/autopsy/threadutils/TaskRetryUtil.java | 7 +------ .../sleuthkit/autopsy/url/analytics/DomainCategorizer.java | 2 +- .../autopsy/recentactivity/DefaultDomainCategorizer.java | 2 +- 5 files changed, 6 insertions(+), 11 deletions(-) diff --git a/Core/src/org/sleuthkit/autopsy/communications/CVTPersonaCache.java b/Core/src/org/sleuthkit/autopsy/communications/CVTPersonaCache.java index 974d7ca299..ac81b15de6 100755 --- a/Core/src/org/sleuthkit/autopsy/communications/CVTPersonaCache.java +++ b/Core/src/org/sleuthkit/autopsy/communications/CVTPersonaCache.java @@ -82,9 +82,9 @@ final public class CVTPersonaCache { } /** - * Returns the list of PersonaAccounts for the given Account typeSpecificId. + * Returns the list of PersonaAccounts for the given Account. * - * @param typeSpecificID Account typeSpecificId. + * @param account The account. * * @return List of PersonaAccounts for id or empty list if none were found. * diff --git a/Core/src/org/sleuthkit/autopsy/contentviewers/artifactviewers/GeneralPurposeArtifactViewer.java b/Core/src/org/sleuthkit/autopsy/contentviewers/artifactviewers/GeneralPurposeArtifactViewer.java index 6dbf8f34e5..e0a41fe0de 100644 --- a/Core/src/org/sleuthkit/autopsy/contentviewers/artifactviewers/GeneralPurposeArtifactViewer.java +++ b/Core/src/org/sleuthkit/autopsy/contentviewers/artifactviewers/GeneralPurposeArtifactViewer.java @@ -243,7 +243,7 @@ public class GeneralPurposeArtifactViewer extends AbstractArtifactDetailsPanel i * @param attributeMap The map of attributes that exist for the artifact. * @param dataSourceName The name of the datasource that caused the creation * of the artifact. - * @param sourceFileName The name of the file that caused the creation of + * @param sourceFilePath The path of the file that caused the creation of * the artifact. */ @NbBundle.Messages({"GeneralPurposeArtifactViewer.dates.created=Created", diff --git a/Core/src/org/sleuthkit/autopsy/threadutils/TaskRetryUtil.java b/Core/src/org/sleuthkit/autopsy/threadutils/TaskRetryUtil.java index 764208e628..e00cedab83 100755 --- a/Core/src/org/sleuthkit/autopsy/threadutils/TaskRetryUtil.java +++ b/Core/src/org/sleuthkit/autopsy/threadutils/TaskRetryUtil.java @@ -56,11 +56,6 @@ public class TaskRetryUtil { * Constructs an object that encapsulates the specification of a task * attempt for the attemptTask() utility. The attempt will have neither * a delay nor a time out. - * - * @param delay The delay before the task should be attempted, - * may be zero or any positive integer. - * @param delayTimeUnit The time unit for the delay before the task - * should be attempted. */ public TaskAttempt() { this.delay = 0L; @@ -168,7 +163,7 @@ public class TaskRetryUtil { * each attempt and an optional timeout for each attempt. If an attempt * times out, that particular attempt task will be cancelled. * - * @param The return type of the task. + * @tparam T The return type of the task. * @param task The task. * @param attempts The defining details for each attempt of the task. * @param executor The scheduled task executor to be used to attempt the diff --git a/Core/src/org/sleuthkit/autopsy/url/analytics/DomainCategorizer.java b/Core/src/org/sleuthkit/autopsy/url/analytics/DomainCategorizer.java index 513fd3bb08..4bce3c58d7 100644 --- a/Core/src/org/sleuthkit/autopsy/url/analytics/DomainCategorizer.java +++ b/Core/src/org/sleuthkit/autopsy/url/analytics/DomainCategorizer.java @@ -26,7 +26,7 @@ import com.google.common.annotations.Beta; * and should have a class annotation of '(at)ServiceProvider(service = * DomainCategoryProvider.class)'. * - * NOTE: The @SuppressWarnings("try") on the class is to suppress warnings + * NOTE: The (at)SuppressWarnings("try") on the class is to suppress warnings * relating to the fact that the close method can throw an InterruptedException * since Exception can encompass the InterruptedException. See the following * github issue and bugs for more information: diff --git a/RecentActivity/src/org/sleuthkit/autopsy/recentactivity/DefaultDomainCategorizer.java b/RecentActivity/src/org/sleuthkit/autopsy/recentactivity/DefaultDomainCategorizer.java index 058b639091..0d64661f6c 100644 --- a/RecentActivity/src/org/sleuthkit/autopsy/recentactivity/DefaultDomainCategorizer.java +++ b/RecentActivity/src/org/sleuthkit/autopsy/recentactivity/DefaultDomainCategorizer.java @@ -45,7 +45,7 @@ import org.sleuthkit.autopsy.url.analytics.DomainCategory; * messaging: * https://www.raymond.cc/blog/list-of-web-messengers-for-your-convenience/ * - * NOTE: The @SuppressWarnings("try") on the class is to suppress warnings + * NOTE: The (at)SuppressWarnings("try") on the class is to suppress warnings * relating to the fact that the close method can throw an InterruptedException * since Exception can encompass the InterruptedException. See the following * github issue and bugs for more information: