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;
}
/**
* 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<>();
@ -145,6 +149,9 @@ public class ReportGenerator {
/**
* Generates the reports specified by the reporting configuration passed in
* 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) {