From 3d78507bb9266daf8fb29b1f1b949cda8425bbdb Mon Sep 17 00:00:00 2001
From: Eugene Livis <elivis@basistech.com>
Date: Tue, 14 Jan 2020 14:30:16 -0500
Subject: [PATCH] Updated javadocs
---
.../autopsy/report/infrastructure/ReportGenerator.java | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/Core/src/org/sleuthkit/autopsy/report/infrastructure/ReportGenerator.java b/Core/src/org/sleuthkit/autopsy/report/infrastructure/ReportGenerator.java
index 302e9dc250..04c5413641 100644
--- a/Core/src/org/sleuthkit/autopsy/report/infrastructure/ReportGenerator.java
+++ b/Core/src/org/sleuthkit/autopsy/report/infrastructure/ReportGenerator.java
@@ -121,6 +121,10 @@ public ReportGenerator(String configName, ReportProgressIndicator progressIndica
this.configName = configName;
}
+ /**
+ * Generates the reports specified by the reporting configuration passed
+ * in via the constructor. Does lookup of all existing report modules.
+ */
public void generateReports() {
// load all report modules
Map<String, ReportModule> modules = new HashMap<>();
@@ -144,7 +148,10 @@ public void generateReports() {
/**
* Generates the reports specified by the reporting configuration passed in
- * via the constructor.
+ * via the constructor.
+ *
+ * @param modules Map of report module objects to use. This is useful when we want to
+ * re-use the module instances or limit which reports are generated.
*/
public void generateReports(Map<String, ReportModule> modules) {
--
GitLab