elharo commented on code in PR #19:
URL:
https://github.com/apache/maven-reporting-api/pull/19#discussion_r1378734859
##########
src/main/java/org/apache/maven/reporting/MavenReport.java:
##########
@@ -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.
Review Comment:
delete base
##########
src/main/java/org/apache/maven/reporting/MavenReport.java:
##########
@@ -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
Review Comment:
I'm not sure the word "base" adds anything here
output of --> the output of
##########
src/main/java/org/apache/maven/reporting/MavenReport.java:
##########
@@ -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
Review Comment:
delete "base"
##########
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
Review Comment:
delete "The base location may contain path components
* to better structure the report output". as it's not relevant to this
method. Possibly the interaction of the methods could be described in the class
level comment
##########
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()}
Review Comment:
This one is a little hard to describe because what the API does is
complicated. On first read, I thought this was just a file name but it's not.
But now I read it a third time and maybe it is just a file name? I don't know.
If it is just a file name, then "Returns the name of the output file that
will be written in {@link #getReportOutputDirectory()}"
If it can contain subdirectories, then "Returns a path relative to {@link
#getReportOutputDirectory()} where the output file will be written."
--
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
