This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch MSHARED-1326
in repository https://gitbox.apache.org/repos/asf/maven-reporting-impl.git
commit 932c55fa2cf811f63b4e890e5f709f3edf1b3b38
Author: Michael Osipov <micha...@apache.org>
AuthorDate: Sun Oct 22 22:31:49 2023 +0200
[MSHARED-1326] Improve (documentation on) AbstractMavenReport class
Co-authored-by: Alexander Kriegisch <alexan...@kriegisch.name>
---
.../org/apache/maven/reporting/AbstractMavenReport.java | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/src/main/java/org/apache/maven/reporting/AbstractMavenReport.java
b/src/main/java/org/apache/maven/reporting/AbstractMavenReport.java
index 8b3193b..e48eb86 100644
--- a/src/main/java/org/apache/maven/reporting/AbstractMavenReport.java
+++ b/src/main/java/org/apache/maven/reporting/AbstractMavenReport.java
@@ -74,9 +74,15 @@ import static
org.apache.maven.shared.utils.logging.MessageUtils.buffer;
*/
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 shared base 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 shared base
+ * output 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.
+ *<br>
+ * A plugin may use any subdirectory structure (either using a hard-coded
name or, ideally, an additional
+ * user-defined mojo parameter with a default value) to generate
multi-page reports or external reports with the
+ * main output file (entry point) denoted by {@link #getOutputName()}.
*/
@Parameter(defaultValue = "${project.reporting.outputDirectory}", readonly
= true, required = true)
protected File outputDirectory;
@@ -165,7 +171,7 @@ public abstract class AbstractMavenReport extends
AbstractMojo implements MavenM
/** The sink factory to use */
private SinkFactory sinkFactory;
- /** The current report output directory to use */
+ /** The current shared base output directory to use */
private File reportOutputDirectory;
/**
