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

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: maven-reporting-impl-4.0.0-M11, maven-reporting-api-4.0.0-M8
• Fix Version/s: maven-reporting-api-4.0.0-M9, maven-reporting-impl-4.0.0-M12, maven-reporting-api-4.0.0, maven-reporting-impl-4.0.0
• Component/s: maven-reporting-api
• Assignee: Michael Osipov
• Reporter: Michael Osipov
• Created: 22/Oct/23 19:21
• Updated: 14/Dec/23 16:55
• Resolved: 06/Nov/23 20:57

Description

Based on a discussion 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 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.

Issue Links

• causes: DOXIASITETOOLS-319 Improve DocumentRenderer interface/DocumentRenderingContext class API
• is related to: MSHARED-1327 Change default value of output directory in AbstractMavenReport
• links to: GitHub Pull Request #19
• links to: GitHub Pull Request #25