Doxygen fixes

This commit is contained in:
apriestman 2020-06-01 13:54:01 -04:00
parent bd297c54da
commit 548ac6675d
10 changed files with 13 additions and 7 deletions

View File

@ -199,6 +199,8 @@ abstract class ReplaceTagAction<T extends Tag> extends AbstractAction implements
* Build a JMenu for the given TagSet.
*
* @param tagSet
* @param tagNamesToDisable
* @param selectedTags
*
* @return JMenu for the given TagSet
*/
@ -217,6 +219,8 @@ abstract class ReplaceTagAction<T extends Tag> extends AbstractAction implements
* Create a menu item for the given TagName.
*
* @param tagName TagName from which to create the menu item.
* @param tagNamesToDisable
* @param selectedTags
*
* @return Menu item for given TagName.
*/

View File

@ -2506,6 +2506,7 @@ public class Case {
* specific to this case.
*
* @param progressIndicator A progress indicator.
* @param isNewCase True if case is new
*
* @throws CaseActionException If there is a problem completing the
* operation. The exception will have a

View File

@ -46,7 +46,7 @@ public class BlackBoardArtifactTagDeletedEvent extends TagDeletedEvent<Blackboar
}
/**
* Extension of {@link DeletedTagInfo} for BlackBoardArtifactTags that
* Extension of DeletedTagInfo for BlackBoardArtifactTags that
* includes artifact related info.
*/
@Immutable

View File

@ -46,7 +46,7 @@ public class ContentTagDeletedEvent extends TagDeletedEvent<ContentTag> implemen
}
/**
* Extension of {@link DeletedTagInfo} for BlackBoardArtifactTags that
* Extension of DeletedTagInfo for BlackBoardArtifactTags that
* includes byte offset related info.
*/
@Immutable

View File

@ -258,7 +258,6 @@ public class Persona {
* Associates an account with a persona by creating a row in the
* PersonaAccounts table.
*
* @param persona Persona to add the account to.
* @param account Account to add to persona.
* @param justification Reason for adding the account to persona, may be
* null.
@ -658,7 +657,7 @@ public class Persona {
/**
* Get all the persona for a given data source.
*
* @param CorrelationDataSource Data source to look the persona in.
* @param dataSource Data source to look the persona in.
*
* @return Collection of personas, may be empty.
* @throws CentralRepoException

View File

@ -96,7 +96,7 @@ public final class WaypointBuilder {
/**
* This function will be called after the waypoints have been filtered.
*
* @param wwaypoints This of waypoints.
* @param waypoints The list of waypoints.
*/
void process(List<Waypoint> waypoints);
}

View File

@ -50,6 +50,7 @@ public final class CheckBoxListPanel<T> extends javax.swing.JPanel {
* Add a new element to the check box list.
*
* @param displayName display name for the checkbox
* @param icon
* @param obj Object that the checkbox represents
*/
public void addElement(String displayName, Icon icon, T obj) {

View File

@ -590,6 +590,7 @@ public class HashDbIngestModule implements FileIngestModule {
*
* @param jobId The ID of the job.
* @param knownBadHashSets The list of hash sets for "known bad" files.
* @param noChangeHashSets The list of "no change" hash sets.
* @param knownHashSets The list of hash sets for "known" files.
*/
@Messages("HashDbIngestModule.complete.noChangesFound=No Change items found:")

View File

@ -109,7 +109,7 @@ public final class CaseUcoReportModule implements GeneralReportModule {
/**
* Generates a CASE-UCO format report for all files in the Case.
*
* @param baseReportDir caseDirPath to save the report
* @param settings Report settings.
* @param progressPanel panel to update the report's progress
*/
@NbBundle.Messages({

View File

@ -93,7 +93,7 @@ public class STIXReportModule implements GeneralReportModule {
}
/**
* @param baseReportDir path to save the report
* @param settings Report settings.
* @param progressPanel panel to update the report's progress
*/
@Override