Merge pull request #5240 from APriestman/doxygenFixes_0922

Doxygen fixes
This commit is contained in:
Richard Cordovano 2019-09-23 10:09:35 -04:00 committed by GitHub
commit 05dfd1adb6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 6 deletions

View File

@ -282,6 +282,7 @@ public class ReportGenerator {
/** /**
* Run the TableReportModules using a SwingWorker. * Run the TableReportModules using a SwingWorker.
* *
* @param tableReport
* @param tableReportSettings settings for the table report * @param tableReportSettings settings for the table report
*/ */
private void generateTableReport(TableReportModule tableReport, TableReportSettings tableReportSettings) throws IOException { private void generateTableReport(TableReportModule tableReport, TableReportSettings tableReportSettings) throws IOException {
@ -301,6 +302,7 @@ public class ReportGenerator {
/** /**
* Run the FileReportModules using a SwingWorker. * Run the FileReportModules using a SwingWorker.
* *
* @param fileReportModule
* @param fileReportSettings settings for the file report * @param fileReportSettings settings for the file report
*/ */
private void generateFileListReport(FileReportModule fileReportModule, FileReportSettings fileReportSettings) throws IOException { private void generateFileListReport(FileReportModule fileReportModule, FileReportSettings fileReportSettings) throws IOException {

View File

@ -461,7 +461,7 @@ public class HTMLReport implements TableReportModule {
* temporary workaround to avoid modifying the TableReportModule interface. * temporary workaround to avoid modifying the TableReportModule interface.
* *
* @param name Name of the data type * @param name Name of the data type
* @param comment Comment on the data type, may be the empty string * @param description Comment on the data type, may be the empty string
*/ */
@Override @Override
public void startDataType(String name, String description) { public void startDataType(String name, String description) {
@ -644,7 +644,6 @@ public class HTMLReport implements TableReportModule {
* temporary workaround to avoid modifying the TableReportModule interface. * temporary workaround to avoid modifying the TableReportModule interface.
* *
* @param columnHeaders column headers * @param columnHeaders column headers
* @param sourceArtifact source blackboard artifact for the table data
*/ */
public void startContentTagsTable(List<String> columnHeaders) { public void startContentTagsTable(List<String> columnHeaders) {
StringBuilder htmlOutput = new StringBuilder(); StringBuilder htmlOutput = new StringBuilder();
@ -718,12 +717,10 @@ public class HTMLReport implements TableReportModule {
/** /**
* Saves a local copy of a tagged file and adds a row with a hyper link to * Saves a local copy of a tagged file and adds a row with a hyper link to
* the file. The content of the hyperlink is provided in linkHTMLContent. * the file.
* *
* @param row Values for each data cell in the row * @param row Values for each data cell in the row
* @param file The file to link to in the report. * @param contentTag The tag
* @param tagName the name of the tag that the content was flagged by
* @param linkHTMLContent the html that will be the body of the link
*/ */
public void addRowWithTaggedContentHyperlink(List<String> row, ContentTag contentTag) { public void addRowWithTaggedContentHyperlink(List<String> row, ContentTag contentTag) {
Content content = contentTag.getContent(); Content content = contentTag.getContent();

View File

@ -267,6 +267,7 @@ public class STIXReportModule implements GeneralReportModule {
* *
* @param stix STIXPackage * @param stix STIXPackage
* @param output * @param output
* @param progressPanel
*/ */
private void processIndicators(STIXPackage stix, BufferedWriter output, ReportProgressPanel progressPanel) throws TskCoreException { private void processIndicators(STIXPackage stix, BufferedWriter output, ReportProgressPanel progressPanel) throws TskCoreException {
if (stix.getIndicators() != null) { if (stix.getIndicators() != null) {
@ -304,6 +305,7 @@ public class STIXReportModule implements GeneralReportModule {
* *
* @param ind * @param ind
* @param result * @param result
* @param progressPanel
* *
* @throws TskCoreException * @throws TskCoreException
*/ */