[EASYANT-77] PluginReport task outputs incomplete/wrong information

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 0.10
• Fix Version/s: 0.10
• Component/s: Core
• Labels: documentation easyant patch reporting
• Flags: Patch
• Assignee: Jean-Louis Boudart
• Reporter: Adrien Quillet
• Created: 09/Aug/16 07:35
• Updated: 22/Aug/16 19:08
• Resolved: 22/Aug/16 19:08

Description

The PluginReport task is used in easyant-plugin-documentation to generate build-types/plugins documentation.

The generated doc has:

• an XML file
• an HTML file, resulting of the transformation of the XML file

In both files, there are some issues that make the documentation incomplete and wrong:

• In XML file:
  • configuration field deprecated is null when configuration is not deprecated (should be ""),
  • Path parameters does not have the required attribute (but properties have this field),
  • Parameters and properties are always declared as not required (required field is always set to false)
• In HTML file:
  • all issues from XML file (since it is generated from it),
  • Only the first configuration is displayed,
  • Path parameters are not displayed

I will attach a Git patch to fix those issues and create a pull request in the coming days.

Edit: the deprecated field is set with the date of deprecation. If deprecated is null, it should display nothing instead of the null value (http://ant.apache.org/ivy/history/latest-milestone/ivyfile/conf.html)

Issue Links

• links to: GitHub Pull Request #3