[MSHARED-1326] Improve MavenReport interface/AbstractMavenReport class API

[jira-importer]

Michael Osipov opened MSHARED-1326 and commented

Based on a discussion with Alexander Kriegisch, 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 that 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.

---

Affects: maven-reporting-impl-4.0.0-M11, maven-reporting-api-4.0.0-M8

Issue Links:

• DOXIASITETOOLS-319 Improve DocumentRenderer interface/DocumentRenderingContext class API
  ("causes")
• MSHARED-1327 Change default value of output directory in AbstractMavenReport

Remote Links:

• GitHub Pull Request #19
  
• GitHub Pull Request #25
  

Backported to: maven-reporting-impl-4.0.0-M12, maven-reporting-api-4.0.0

[jira-importer]

Michael Osipov commented

Renaming would be problematic because the same method name is used in Doxia Sitetools and they would need to be renamed as well for consistency reasons.

[jira-importer]

Michael Osipov commented

Fixed with 65e9ed4606bfe902d2f340a78a1e376a34c11ad3 for maven-reporting-api and with cdf9631120a223b3b3cc740689c42729a50c63c5 for maven-reporting-impl.