(maven-reporting-api) 01/01: [MSHARED-1326] Improve (documentation on) MavenReport interface

[michaelo]

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-api.git

commit f9f634a63e5971c43b41fcb7f6624bf5c8d0847c
Author: Michael Osipov <micha...@apache.org>
AuthorDate: Sun Oct 22 21:53:06 2023 +0200

    [MSHARED-1326] Improve (documentation on) MavenReport interface
---
 src/main/java/org/apache/maven/reporting/MavenReport.java | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/src/main/java/org/apache/maven/reporting/MavenReport.java 
b/src/main/java/org/apache/maven/reporting/MavenReport.java
index 733ba96..8c28a8c 100644
--- a/src/main/java/org/apache/maven/reporting/MavenReport.java
+++ b/src/main/java/org/apache/maven/reporting/MavenReport.java
@@ -53,7 +53,9 @@ public interface MavenReport {
     void generate(Sink sink, Locale locale) throws MavenReportException;
 
     /**
-     * Get the base name used to create report's output file(s).
+     * Get the output name denoting a base location relative to the {@link 
#getReportOutputDirectory()}
+     * used to create the report's main output file. The base location may 
contain path components
+     * to better structure the report output.
      *
      * @return the output name of this report.
      */
@@ -84,14 +86,17 @@ public interface MavenReport {
     String getDescription(Locale locale);
 
     /**
-     * Set a new output directory. Useful for staging.
+     * Set a new shared base report output directory. This directory may 
contain output of other
+     * reports as well.
      *
-     * @param outputDirectory the new output directory
+     * @param outputDirectory the new shared base report output directory
      */
     void setReportOutputDirectory(File outputDirectory);
 
     /**
-     * @return the current report output directory.
+     * Get the shared base report output directory.
+     *
+     * @return the current shared base report output directory.
      */
     File getReportOutputDirectory();