Merge pull request #5207 from APriestman/doxygen_9_17

Doxygen fixes
This commit is contained in:
Richard Cordovano 2019-09-17 15:53:22 -04:00 committed by GitHub
commit aa2bccd32d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 18 additions and 19 deletions

View File

@ -80,7 +80,7 @@ public class Services implements Closeable {
/** /**
* Gets the artifacts blackboard for the current case. * 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. * case.
*/ */
public org.sleuthkit.datamodel.Blackboard getArtifactsBlackboard() { public org.sleuthkit.datamodel.Blackboard getArtifactsBlackboard() {

View File

@ -283,8 +283,8 @@ public final class AppDBParserHelper {
/** /**
* Adds a relations between the two specified account instances. * Adds a relations between the two specified account instances.
* *
* @param selfAccount device owner account * @param selfAccountInstance device owner account
* @param otherAccount other account * @param otherAccountInstance other account
* @param sourceArtifact artifact from which relationship is derived. * @param sourceArtifact artifact from which relationship is derived.
* @param relationshipType type of relationship * @param relationshipType type of relationship
* @param dateTime date/time of relationship * @param dateTime date/time of relationship
@ -316,7 +316,7 @@ public final class AppDBParserHelper {
* @param readStatus message read or not * @param readStatus message read or not
* @param subject message subject, may be empty * @param subject message subject, may be empty
* @param messageText message body, may be empty * @param messageText message body, may be empty
* @param threadId, message thread id * @param threadId message thread id
* *
* @return message artifact * @return message artifact
*/ */
@ -347,7 +347,7 @@ public final class AppDBParserHelper {
* @param readStatus message read or not * @param readStatus message read or not
* @param subject message subject, may be empty * @param subject message subject, may be empty
* @param messageText message body, may be empty * @param messageText message body, may be empty
* @param threadId, message thread id * @param threadId message thread id
* *
* @param otherAttributesList additional attributes * @param otherAttributesList additional attributes
* *
@ -385,7 +385,7 @@ public final class AppDBParserHelper {
* @param readStatus message read or not * @param readStatus message read or not
* @param subject message subject, may be empty * @param subject message subject, may be empty
* @param messageText message body, may be empty * @param messageText message body, may be empty
* @param threadId, message thread id * @param threadId message thread id
* *
* *
* @return message artifact * @return message artifact
@ -867,7 +867,7 @@ public final class AppDBParserHelper {
* @param accessTime last access time * @param accessTime last access time
* @param referrer referrer, may be empty * @param referrer referrer, may be empty
* @param title website title, 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 * @return artifact created
*/ */
@ -884,7 +884,7 @@ public final class AppDBParserHelper {
* @param accessTime last access time * @param accessTime last access time
* @param referrer referrer, may be empty * @param referrer referrer, may be empty
* @param title website title, 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 * @param otherAttributesList other attributes
* *
* *

View File

@ -95,8 +95,8 @@ public final class AppSQLiteDB implements Closeable {
* AppSQLiteDB to help query the DB. * AppSQLiteDB to help query the DB.
* *
* A list of AppSQLiteDB instances is returned, one for each * A list of AppSQLiteDB instances is returned, one for each
* match found., * match found.
* . *
* @param dataSource data source to search in * @param dataSource data source to search in
* @param dbName db file name to search * @param dbName db file name to search
* @param matchExactName whether to look for exact file name or a pattern match * @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 dbName db file name to search
* @param matchExactName whether to look for exact file name or a pattern match * @param matchExactName whether to look for exact file name or a pattern match
* @param dbPath path to 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 * @return a collection of AppSQLiteDBFileBundle
* *

View File

@ -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 * the following interesting file sets (set name attributes of TSK_INTERSTING_FILE_HIT
* and TSK_INTERESTING_ARTIFACT_HIT). Artifacts that are tagged with * and TSK_INTERESTING_ARTIFACT_HIT). Artifacts that are tagged with
* the following TagNames also have their associated source files included. * 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 tagTypes Collection of TagNames to match
* @param interestingItemSets Collection of SET_NAMEs to match on in TSK_INTERESTING_FILE_HITs * @param interestingItemSets Collection of SET_NAMEs to match on in TSK_INTERESTING_FILE_HITs
* and TSK_INTERESTING_ARTIFACT_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 * @param progressPanel UI Component to be updated with current processing status
*/ */
@NbBundle.Messages({ @NbBundle.Messages({

View File

@ -127,6 +127,7 @@ public class AddManualEvent extends Action {
* Use the supplied ManualEventInfo to make an TSK_TL_EVENT artifact which * Use the supplied ManualEventInfo to make an TSK_TL_EVENT artifact which
* will trigger adding a TimelineEvent. * will trigger adding a TimelineEvent.
* *
* @param controller
* @param eventInfo The ManualEventInfo with the info needed to create an * @param eventInfo The ManualEventInfo with the info needed to create an
* event. * event.
* *

View File

@ -102,6 +102,7 @@ final public class DetailsViewModel {
} }
/** /**
* @param uiFilter
* @param zoom * @param zoom
* *
* @return a list of aggregated events that are within the requested time * @return a list of aggregated events that are within the requested time

View File

@ -121,8 +121,6 @@ public class CompoundFilterState<SubFilterType extends TimelineFilter, FilterTyp
/** /**
* Disable the sub-filters of the given compound filter if it is not active * Disable the sub-filters of the given compound filter if it is not active
*
* @param compoundFilter the compound filter
*/ */
private void disableSubFiltersIfNotActive() { private void disableSubFiltersIfNotActive() {
boolean inactive = isActive() == false; boolean inactive = isActive() == false;

View File

@ -45,7 +45,6 @@ public class CombinedEvent {
* *
* @param epochMillis The timestamp for this event, in millis from the Unix * @param epochMillis The timestamp for this event, in millis from the Unix
* epoch. * epoch.
* @param fileID The ID of the file shared by all the combined events.
* @param eventMap A map from EventType to event ID. * @param eventMap A map from EventType to event ID.
*/ */
public CombinedEvent(long epochMillis, Map<TimelineEventType, Long> eventMap) { public CombinedEvent(long epochMillis, Map<TimelineEventType, Long> eventMap) {

View File

@ -63,7 +63,7 @@ public class TimelineDBUtils {
* into a set of X using the mapper to convert from string to X. If * 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. * groupConcat is empty, null, or all whitespace, returns an empty list.
* *
* @param <X> the type of elements to return * X the type of elements to return
* @param groupConcat a string containing the group_concat result ( a comma * @param groupConcat a string containing the group_concat result ( a comma
* separated list) * separated list)
* @param mapper a function from String to X * @param mapper a function from String to X

View File

@ -411,7 +411,7 @@ public final class ThunderbirdMboxFileIngestModule implements FileIngestModule {
* appropriate artifacts and derived files. * appropriate artifacts and derived files.
* *
* @param partialEmailsForThreading * @param partialEmailsForThreading
* @param fileMessageIterator * @param fullMessageIterator
* @param abstractFile * @param abstractFile
*/ */
private void processEmails(List<EmailMessage> partialEmailsForThreading, Iterator<EmailMessage> fullMessageIterator, AbstractFile abstractFile) { private void processEmails(List<EmailMessage> partialEmailsForThreading, Iterator<EmailMessage> fullMessageIterator, AbstractFile abstractFile) {