[jira] [Created] (MSHARED-1326) Improve (documentation on) MavenReport interface

["Michael Osipov (Jira)" <ji...@apache.org>]

Michael Osipov created MSHARED-1326:
---------------------------------------

             Summary: Improve (documentation on) MavenReport interface
                 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-api-4.0.0-M8
            Reporter: Michael Osipov
            Assignee: Michael Osipov
             Fix For: maven-reporting-api-4.0.0-M9


Based on a [discussion|https://lists.apache.org/thread/6yxlvbhb7odfylfgjgzbvmvxg0vry20b] with [~kriegaex], there are few conceptional or documentational issued with the {{MavenReport}} interface:

* {{#getOutputName()}} does not clearly say that is actually an optional base *path* and base name of the report item from a reporting output directory. It needs at least a doc update and maybe even a rename to {{#getOutputPath()}}?
* 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)