Skip to content
Snippets Groups Projects
Commit 3d78507b authored by Eugene Livis's avatar Eugene Livis
Browse files

Updated javadocs

parent 66ca34fe
No related branches found
No related tags found
No related merge requests found
...@@ -121,6 +121,10 @@ public ReportGenerator(String configName, ReportProgressIndicator progressIndica ...@@ -121,6 +121,10 @@ public ReportGenerator(String configName, ReportProgressIndicator progressIndica
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 void generateReports() { ...@@ -144,7 +148,10 @@ public void generateReports() {
/** /**
* 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) {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment