Fix doxygen warnings.

Remove missed stix reference.
This commit is contained in:
apriestman 2021-09-21 12:49:27 -04:00
parent 9ab0c4b963
commit 66632bcb52
7 changed files with 21 additions and 12 deletions

View File

@ -133,7 +133,7 @@ public class CorrelationAttributeUtil {
* whether receiving a null return value is an error or not, plus null * whether receiving a null return value is an error or not, plus null
* checking is easy to forget, while catching exceptions is enforced. * 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 * @return A list, possibly empty, of correlation attribute instances for
* the content. * the content.
@ -298,6 +298,7 @@ public class CorrelationAttributeUtil {
* *
* @param corrAttrInstances Correlation attributes will be added to this. * @param corrAttrInstances Correlation attributes will be added to this.
* @param artifact An artifact with a phone number attribute. * @param artifact An artifact with a phone number attribute.
* @param attributes List of attributes.
* *
* @throws TskCoreException If there is an error * @throws TskCoreException If there is an error
* querying the case * querying the case
@ -393,11 +394,12 @@ public class CorrelationAttributeUtil {
* *
* @param corrAttrInstances A list of correlation attribute instances. * @param corrAttrInstances A list of correlation attribute instances.
* @param artifact An artifact. * @param artifact An artifact.
* @param artAttrType The type of the atrribute of the artifact that * @param artAttrType The type of the attribute of the artifact that
* is to be made into a correlatin attribute * is to be made into a correlation attribute
* instance. * instance.
* @param typeId The type ID for the desired correlation * @param typeId The type ID for the desired correlation
* attribute instance. * attribute instance.
* @param attributes List of attributes.
* @param sourceContent The source content object. * @param sourceContent The source content object.
* @param dataSource The data source content object. * @param dataSource The data source content object.
* *
@ -427,11 +429,12 @@ public class CorrelationAttributeUtil {
* *
* @param corrAttrInstances A list of correlation attribute instances. * @param corrAttrInstances A list of correlation attribute instances.
* @param artifact An artifact. * @param artifact An artifact.
* @param artAttrType The type of the atrribute of the artifact that * @param artAttrType The type of the attribute of the artifact that
* is to be made into a correlatin attribute * is to be made into a correlation attribute
* instance. * instance.
* @param typeId The type ID for the desired correlation * @param typeId The type ID for the desired correlation
* attribute instance. * attribute instance.
* @param attributes List of attributes.
* *
* @throws CentralRepoException If there is an error querying the central * @throws CentralRepoException If there is an error querying the central
* repository. * repository.
@ -555,7 +558,7 @@ public class CorrelationAttributeUtil {
* account. Checks address if it is null, or one of the ones always present * account. Checks address if it is null, or one of the ones always present
* on a windows system and thus not unique. * 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. * @param dataSource The data source content object.
* *
* @return The correlation attribute instance or null, if an error occurred. * @return The correlation attribute instance or null, if an error occurred.

View File

@ -229,6 +229,8 @@ public class IngestEventsListener {
* @param originalArtifact Original artifact that we want to flag * @param originalArtifact Original artifact that we want to flag
* @param caseDisplayNames List of case names artifact was previously seen * @param caseDisplayNames List of case names artifact was previously seen
* in * in
* @param aType The correlation type.
* @param value The correlation value.
*/ */
@NbBundle.Messages({"IngestEventsListener.prevTaggedSet.text=Previously Tagged As Notable (Central Repository)", @NbBundle.Messages({"IngestEventsListener.prevTaggedSet.text=Previously Tagged As Notable (Central Repository)",
"IngestEventsListener.prevCaseComment.text=Previous Case: "}) "IngestEventsListener.prevCaseComment.text=Previous Case: "})
@ -259,6 +261,8 @@ public class IngestEventsListener {
* @param originalArtifact the artifact to create the "previously seen" item for * @param originalArtifact the artifact to create the "previously seen" item for
* @param caseDisplayNames the case names the artifact was previously seen * @param caseDisplayNames the case names the artifact was previously seen
* in * in
* @param aType The correlation type.
* @param value The correlation value.
*/ */
@NbBundle.Messages({"IngestEventsListener.prevExists.text=Previously Seen Devices (Central Repository)", @NbBundle.Messages({"IngestEventsListener.prevExists.text=Previously Seen Devices (Central Repository)",
"# {0} - typeName", "# {0} - typeName",
@ -303,6 +307,8 @@ public class IngestEventsListener {
* *
* @param originalArtifact the artifact to create the "previously unseen" item * @param originalArtifact the artifact to create the "previously unseen" item
* for * for
* @param aType The correlation type.
* @param value The correlation value.
*/ */
static private void makeAndPostPreviouslyUnseenArtifact(BlackboardArtifact originalArtifact, CorrelationAttributeInstance.Type aType, String value) { static private void makeAndPostPreviouslyUnseenArtifact(BlackboardArtifact originalArtifact, CorrelationAttributeInstance.Type aType, String value) {
Collection<BlackboardAttribute> attributesForNewArtifact = Arrays.asList( Collection<BlackboardAttribute> attributesForNewArtifact = Arrays.asList(
@ -319,6 +325,7 @@ public class IngestEventsListener {
/** /**
* Make an artifact to flag the passed in artifact. * 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 originalArtifact Artifact in current case we want to flag
* @param attributesForNewArtifact Attributes to assign to the new artifact * @param attributesForNewArtifact Attributes to assign to the new artifact
* @param configuration The configuration to be specified for the new artifact hit * @param configuration The configuration to be specified for the new artifact hit

View File

@ -834,7 +834,7 @@ public class BlackboardArtifactNode extends AbstractContentNode<BlackboardArtifa
* repository. * repository.
* *
* @param tags The tags applied to the artifact and its source content. * @param tags The tags applied to the artifact and its source content.
* @param attribute A correlation attribute instance for the central * @param attributes A correlation attribute instance for the central
* repository lookup. * repository lookup.
* *
* @return The value of the comment property. * @return The value of the comment property.
@ -1176,7 +1176,7 @@ public class BlackboardArtifactNode extends AbstractContentNode<BlackboardArtifa
* *
* @param content The content object. * @param content The content object.
* *
* @return A short description\label. * @return A short description/label.
*/ */
private String getContentShortDescription(Content content) { private String getContentShortDescription(Content content) {
if(content != null) { if(content != null) {

View File

@ -99,7 +99,6 @@ public abstract class DisplayableItemNode extends AbstractNode {
* operation on this artifact type and return some object as the result of * operation on this artifact type and return some object as the result of
* the operation. * the operation.
* *
* @param <T> The return type.
* @param visitor The visitor, where the type parameter of the visitor is * @param visitor The visitor, where the type parameter of the visitor is
* the type of the object that will be returned as the result * the type of the object that will be returned as the result
* of the visit operation. * of the visit operation.

View File

@ -170,7 +170,7 @@ public class TypesSummary {
* Constructor that accepts FileTypeCategory. * Constructor that accepts FileTypeCategory.
* *
* @param label The label for this slice. * @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. * @param color The color associated with this slice.
*/ */
public FileTypeCategoryData(String label, FileTypeUtils.FileTypeCategory fileCategory, Color color) { public FileTypeCategoryData(String label, FileTypeUtils.FileTypeCategory fileCategory, Color color) {

View File

@ -126,6 +126,7 @@ public class DomainSearch {
* @param caseDb The case database. * @param caseDb The case database.
* @param centralRepoDb The central repository database. Can be null * @param centralRepoDb The central repository database. Can be null
* if not needed. * if not needed.
* @param context The search context.
* *
* @return A LinkedHashMap grouped and sorted according to the parameters. * @return A LinkedHashMap grouped and sorted according to the parameters.
* *

View File

@ -71,7 +71,6 @@ The following topics are available here:
- \subpage ui_quick_search - \subpage ui_quick_search
- \subpage file_search_page - \subpage file_search_page
- \subpage ad_hoc_keyword_search_page - \subpage ad_hoc_keyword_search_page
- \subpage stix_page
- \subpage common_properties_page - \subpage common_properties_page
- \subpage search_all_cases_page - \subpage search_all_cases_page