Updated javadocs

This commit is contained in:
Eugene Livis 2020-01-14 14:30:16 -05:00
parent 66ca34fea8
commit 3d78507bb9

View File

@ -121,6 +121,10 @@ public class ReportGenerator {
this.configName = configName; 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() { public void generateReports() {
// load all report modules // load all report modules
Map<String, ReportModule> modules = new HashMap<>(); Map<String, ReportModule> modules = new HashMap<>();
@ -144,7 +148,10 @@ public class ReportGenerator {
/** /**
* Generates the reports specified by the reporting configuration passed in * 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) { public void generateReports(Map<String, ReportModule> modules) {