Doxygen fixes

This commit is contained in:
apriestman 2021-01-08 08:45:41 -05:00
parent 041af0fa90
commit d19e1eddaf
5 changed files with 6 additions and 11 deletions

View File

@ -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. * @return List of PersonaAccounts for id or empty list if none were found.
* *

View File

@ -243,7 +243,7 @@ public class GeneralPurposeArtifactViewer extends AbstractArtifactDetailsPanel i
* @param attributeMap The map of attributes that exist for the artifact. * @param attributeMap The map of attributes that exist for the artifact.
* @param dataSourceName The name of the datasource that caused the creation * @param dataSourceName The name of the datasource that caused the creation
* of the artifact. * 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. * the artifact.
*/ */
@NbBundle.Messages({"GeneralPurposeArtifactViewer.dates.created=Created", @NbBundle.Messages({"GeneralPurposeArtifactViewer.dates.created=Created",

View File

@ -56,11 +56,6 @@ public class TaskRetryUtil {
* Constructs an object that encapsulates the specification of a task * Constructs an object that encapsulates the specification of a task
* attempt for the attemptTask() utility. The attempt will have neither * attempt for the attemptTask() utility. The attempt will have neither
* a delay nor a time out. * 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() { public TaskAttempt() {
this.delay = 0L; this.delay = 0L;
@ -168,7 +163,7 @@ public class TaskRetryUtil {
* each attempt and an optional timeout for each attempt. If an attempt * each attempt and an optional timeout for each attempt. If an attempt
* times out, that particular attempt task will be cancelled. * times out, that particular attempt task will be cancelled.
* *
* @param <T> The return type of the task. * @tparam T The return type of the task.
* @param task The task. * @param task The task.
* @param attempts The defining details for each attempt of 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 * @param executor The scheduled task executor to be used to attempt the

View File

@ -26,7 +26,7 @@ import com.google.common.annotations.Beta;
* and should have a class annotation of '(at)ServiceProvider(service = * and should have a class annotation of '(at)ServiceProvider(service =
* DomainCategoryProvider.class)'. * 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 * relating to the fact that the close method can throw an InterruptedException
* since Exception can encompass the InterruptedException. See the following * since Exception can encompass the InterruptedException. See the following
* github issue and bugs for more information: * github issue and bugs for more information:

View File

@ -45,7 +45,7 @@ import org.sleuthkit.autopsy.url.analytics.DomainCategory;
* messaging: * messaging:
* https://www.raymond.cc/blog/list-of-web-messengers-for-your-convenience/ * 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 * relating to the fact that the close method can throw an InterruptedException
* since Exception can encompass the InterruptedException. See the following * since Exception can encompass the InterruptedException. See the following
* github issue and bugs for more information: * github issue and bugs for more information: