From 66632bcb52d518e81bde44cb73882fc34bd2be76 Mon Sep 17 00:00:00 2001 From: apriestman <apriestman@basistech.com> Date: Tue, 21 Sep 2021 12:49:27 -0400 Subject: [PATCH] Fix doxygen warnings. Remove missed stix reference. --- .../datamodel/CorrelationAttributeUtil.java | 15 +++++++++------ .../eventlisteners/IngestEventsListener.java | 7 +++++++ .../autopsy/datamodel/BlackboardArtifactNode.java | 6 +++--- .../autopsy/datamodel/DisplayableItemNode.java | 1 - .../datasourcesummary/datamodel/TypesSummary.java | 2 +- .../autopsy/discovery/search/DomainSearch.java | 1 + docs/doxygen-user/main.dox | 1 - 7 files changed, 21 insertions(+), 12 deletions(-) diff --git a/Core/src/org/sleuthkit/autopsy/centralrepository/datamodel/CorrelationAttributeUtil.java b/Core/src/org/sleuthkit/autopsy/centralrepository/datamodel/CorrelationAttributeUtil.java index c8dfa81f7c..e08bed19c0 100755 --- a/Core/src/org/sleuthkit/autopsy/centralrepository/datamodel/CorrelationAttributeUtil.java +++ b/Core/src/org/sleuthkit/autopsy/centralrepository/datamodel/CorrelationAttributeUtil.java @@ -133,7 +133,7 @@ public static List<CorrelationAttributeInstance> makeCorrAttrsToSave(Content con * whether receiving a null return value is an error or not, plus null * checking is easy to forget, while catching exceptions is enforced. * - * @param Content A Content object. + * @param content A Content object. * * @return A list, possibly empty, of correlation attribute instances for * the content. @@ -298,6 +298,7 @@ private static BlackboardAttribute getAttribute(List<BlackboardAttribute> attrib * * @param corrAttrInstances Correlation attributes will be added to this. * @param artifact An artifact with a phone number attribute. + * @param attributes List of attributes. * * @throws TskCoreException If there is an error * querying the case @@ -393,11 +394,12 @@ private static void makeCorrAttrFromAcctArtifact(List<CorrelationAttributeInstan * * @param corrAttrInstances A list of correlation attribute instances. * @param artifact An artifact. - * @param artAttrType The type of the atrribute of the artifact that - * is to be made into a correlatin attribute + * @param artAttrType The type of the attribute of the artifact that + * is to be made into a correlation attribute * instance. * @param typeId The type ID for the desired correlation * attribute instance. + * @param attributes List of attributes. * @param sourceContent The source content object. * @param dataSource The data source content object. * @@ -427,11 +429,12 @@ private static void makeCorrAttrFromArtifactAttr(List<CorrelationAttributeInstan * * @param corrAttrInstances A list of correlation attribute instances. * @param artifact An artifact. - * @param artAttrType The type of the atrribute of the artifact that - * is to be made into a correlatin attribute + * @param artAttrType The type of the attribute of the artifact that + * is to be made into a correlation attribute * instance. * @param typeId The type ID for the desired correlation * attribute instance. + * @param attributes List of attributes. * * @throws CentralRepoException If there is an error querying the central * repository. @@ -555,7 +558,7 @@ private static CorrelationAttributeInstance makeCorrAttr(BlackboardArtifact arti * account. Checks address if it is null, or one of the ones always present * on a windows system and thus not unique. * - * @param osAccoun The OS account. + * @param osAccount The OS account. * @param dataSource The data source content object. * * @return The correlation attribute instance or null, if an error occurred. diff --git a/Core/src/org/sleuthkit/autopsy/centralrepository/eventlisteners/IngestEventsListener.java b/Core/src/org/sleuthkit/autopsy/centralrepository/eventlisteners/IngestEventsListener.java index cd9e03c9aa..270f436a71 100644 --- a/Core/src/org/sleuthkit/autopsy/centralrepository/eventlisteners/IngestEventsListener.java +++ b/Core/src/org/sleuthkit/autopsy/centralrepository/eventlisteners/IngestEventsListener.java @@ -229,6 +229,8 @@ public synchronized static void setCreateCrProperties(boolean value) { * @param originalArtifact Original artifact that we want to flag * @param caseDisplayNames List of case names artifact was previously seen * in + * @param aType The correlation type. + * @param value The correlation value. */ @NbBundle.Messages({"IngestEventsListener.prevTaggedSet.text=Previously Tagged As Notable (Central Repository)", "IngestEventsListener.prevCaseComment.text=Previous Case: "}) @@ -259,6 +261,8 @@ static private void makeAndPostPreviousNotableArtifact(BlackboardArtifact origin * @param originalArtifact the artifact to create the "previously seen" item for * @param caseDisplayNames the case names the artifact was previously seen * in + * @param aType The correlation type. + * @param value The correlation value. */ @NbBundle.Messages({"IngestEventsListener.prevExists.text=Previously Seen Devices (Central Repository)", "# {0} - typeName", @@ -303,6 +307,8 @@ static private void makeAndPostPreviousSeenArtifact(BlackboardArtifact originalA * * @param originalArtifact the artifact to create the "previously unseen" item * for + * @param aType The correlation type. + * @param value The correlation value. */ static private void makeAndPostPreviouslyUnseenArtifact(BlackboardArtifact originalArtifact, CorrelationAttributeInstance.Type aType, String value) { Collection<BlackboardAttribute> attributesForNewArtifact = Arrays.asList( @@ -319,6 +325,7 @@ static private void makeAndPostPreviouslyUnseenArtifact(BlackboardArtifact origi /** * Make an artifact to flag the passed in artifact. * + * @param newArtifactType Type of artifact to create. * @param originalArtifact Artifact in current case we want to flag * @param attributesForNewArtifact Attributes to assign to the new artifact * @param configuration The configuration to be specified for the new artifact hit diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/BlackboardArtifactNode.java b/Core/src/org/sleuthkit/autopsy/datamodel/BlackboardArtifactNode.java index 64cece2956..cc32ae029f 100644 --- a/Core/src/org/sleuthkit/autopsy/datamodel/BlackboardArtifactNode.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/BlackboardArtifactNode.java @@ -834,8 +834,8 @@ protected final List<Tag> getAllTagsFromDatabase() { * repository. * * @param tags The tags applied to the artifact and its source content. - * @param attribute A correlation attribute instance for the central - * repository lookup. + * @param attributes A correlation attribute instance for the central + * repository lookup. * * @return The value of the comment property. */ @@ -1176,7 +1176,7 @@ private String getSourceObjType(Content source) { * * @param content The content object. * - * @return A short description\label. + * @return A short description/label. */ private String getContentShortDescription(Content content) { if(content != null) { diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/DisplayableItemNode.java b/Core/src/org/sleuthkit/autopsy/datamodel/DisplayableItemNode.java index 6edba5db30..c6bc88129a 100644 --- a/Core/src/org/sleuthkit/autopsy/datamodel/DisplayableItemNode.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/DisplayableItemNode.java @@ -99,7 +99,6 @@ public DisplayableItemNode(Children children, Lookup lookup) { * operation on this artifact type and return some object as the result of * the operation. * - * @param <T> The return type. * @param visitor The visitor, where the type parameter of the visitor is * the type of the object that will be returned as the result * of the visit operation. diff --git a/Core/src/org/sleuthkit/autopsy/datasourcesummary/datamodel/TypesSummary.java b/Core/src/org/sleuthkit/autopsy/datasourcesummary/datamodel/TypesSummary.java index b13e852b95..7eb06e3f68 100755 --- a/Core/src/org/sleuthkit/autopsy/datasourcesummary/datamodel/TypesSummary.java +++ b/Core/src/org/sleuthkit/autopsy/datasourcesummary/datamodel/TypesSummary.java @@ -170,7 +170,7 @@ public FileTypeCategoryData(String label, Set<String> mimeTypes, Color color) { * Constructor that accepts FileTypeCategory. * * @param label The label for this slice. - * @param mimeTypes The mime types associated with this slice. + * @param fileCategory The category associated with this slice. * @param color The color associated with this slice. */ public FileTypeCategoryData(String label, FileTypeUtils.FileTypeCategory fileCategory, Color color) { diff --git a/Core/src/org/sleuthkit/autopsy/discovery/search/DomainSearch.java b/Core/src/org/sleuthkit/autopsy/discovery/search/DomainSearch.java index 0557808758..bfa1f34a0b 100644 --- a/Core/src/org/sleuthkit/autopsy/discovery/search/DomainSearch.java +++ b/Core/src/org/sleuthkit/autopsy/discovery/search/DomainSearch.java @@ -126,6 +126,7 @@ public Map<GroupKey, Integer> getGroupSizes(String userName, * @param caseDb The case database. * @param centralRepoDb The central repository database. Can be null * if not needed. + * @param context The search context. * * @return A LinkedHashMap grouped and sorted according to the parameters. * diff --git a/docs/doxygen-user/main.dox b/docs/doxygen-user/main.dox index c01e5ea76d..a31367ff6c 100644 --- a/docs/doxygen-user/main.dox +++ b/docs/doxygen-user/main.dox @@ -71,7 +71,6 @@ The following topics are available here: - \subpage ui_quick_search - \subpage file_search_page - \subpage ad_hoc_keyword_search_page - - \subpage stix_page - \subpage common_properties_page - \subpage search_all_cases_page -- GitLab