Updated javadocs

sleuthkit · Jan 14, 2020 · 3d78507 · 3d78507
1 parent 66ca34f
commit 3d78507
Showing 1 changed file with 8 additions and 1 deletion.
diff --git 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) {