kriegaex commented on code in PR #26:
URL:
https://github.com/apache/maven-reporting-impl/pull/26#discussion_r1371585628
##########
src/main/java/org/apache/maven/reporting/AbstractMavenReport.java:
##########
@@ -74,11 +74,16 @@
*/
public abstract class AbstractMavenReport extends AbstractMojo implements
MavenMultiPageReport {
/**
- * The output directory for the report. Note that this parameter is only
evaluated if the goal is run directly from
- * the command line. If the goal is run indirectly as part of a site
generation, the output directory configured in
- * the Maven Site Plugin is used instead.
+ * The output base directory for the report. Note that this parameter is
only evaluated if the goal is run directly
+ * from the command line. If the goal is run indirectly as part of a site
generation, the output base directory
+ * configured in the <a
href="https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory";>
+ * Maven Site Plugin</a> is used instead.
+ * <p>
+ * To the respective base directory for each use case (direct mojo call
vs.site generation), implementing plugins
+ * might want to add their specific subdirectories for multi-page reports,
either using a hard-coded name or,
+ * ideally, an additional user-defined mojo parameter with a default value.
Review Comment:
@michael-o, I agree that the descriptions should be consistent. However, I
am not sure what you think is inconsistent, and whether you would rather adjust
the description in the reporting API or here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
