elharo commented on code in PR #19:
URL:
https://github.com/apache/maven-reporting-api/pull/19#discussion_r1380616343
##########
src/main/java/org/apache/maven/reporting/MavenReport.java:
##########
@@ -53,9 +53,10 @@ 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 path relative to {@link #getReportOutputDirectory()} where the
report's main output
+ * file will be written. The last component is expected to be a basename
only.
*
- * @return the output name of this report.
+ * @return the relative path of this report.
Review Comment:
no period
##########
src/main/java/org/apache/maven/reporting/MavenReport.java:
##########
@@ -84,14 +85,17 @@ public interface MavenReport {
String getDescription(Locale locale);
/**
- * Set a new output directory. Useful for staging.
+ * Set a new shared report output directory. This directory may contain
the output of other
+ * reports as well.
*
- * @param outputDirectory the new output directory
+ * @param outputDirectory the new shared report output directory
*/
void setReportOutputDirectory(File outputDirectory);
/**
- * @return the current report output directory.
+ * Get the shared report output directory.
+ *
+ * @return the current shared report output directory.
Review Comment:
no period
##########
src/main/java/org/apache/maven/reporting/MavenReport.java:
##########
@@ -53,9 +53,10 @@ 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 path relative to {@link #getReportOutputDirectory()} where the
report's main output
+ * file will be written. The last component is expected to be a basename
only.
Review Comment:
still not sure what "basename" means. I guess the point is it's a directory,
not a filename?
--
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
