[ https://issues.apache.org/jira/browse/MSHARED-1326?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17781655#comment-17781655 ]
ASF GitHub Bot commented on MSHARED-1326: ----------------------------------------- michael-o commented on PR #19: URL: https://github.com/apache/maven-reporting-api/pull/19#issuecomment-1788619992 @elharo As you are a native English speaker and we don't, would you mind to add your opinion on this? > Improve (documentation on) MavenReport interface/AbstractMavenReport class > -------------------------------------------------------------------------- > > Key: MSHARED-1326 > URL: https://issues.apache.org/jira/browse/MSHARED-1326 > Project: Maven Shared Components > Issue Type: Task > Components: maven-reporting-api > Affects Versions: maven-reporting-impl-4.0.0-M11, > maven-reporting-api-4.0.0-M8 > Reporter: Michael Osipov > Assignee: Michael Osipov > Priority: Major > Fix For: maven-reporting-api-4.0.0-M9, > maven-reporting-impl-4.0.0-M12 > > > Based on a > [discussion|https://lists.apache.org/thread/6yxlvbhb7odfylfgjgzbvmvxg0vry20b] > with [~kriegaex], there are few conceptional or documentational issues with > the {{MavenReport}} interface: > * {{#getOutputName()}} does not clearly say that is actually an optional base > *path* and base name (base location) of the report item from a reporting > output directory. It needs at least a doc update and maybe even a rename to > {{#getOutputPath()}}/{{#getOutputPathLocation()}}? > * Both {{#setReportOutputDirectory(File outputDirectory)}} and > {{#getReportOutputDirectory()}} documentation imply tha this directory solely > refers to this single report, but that is not correct. It refers to root > directory which contains all possibly generated reports. A shared directory, > not exclusive one. Consider your report generates in a subdir, then these do > *not* refer to it, but to its parent. -- This message was sent by Atlassian Jira (v8.20.10#820010)