[
https://issues.apache.org/jira/browse/EASYANT-77?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Adrien Quillet updated EASYANT-77:
----------------------------------
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 {{false}}),
** 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 {{""}})
* 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)
was:
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 {{false}}),
** 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.
> PluginReport task outputs incomplete/wrong information
> ------------------------------------------------------
>
> Key: EASYANT-77
> URL: https://issues.apache.org/jira/browse/EASYANT-77
> Project: EasyAnt
> Issue Type: Bug
> Components: Core
> Affects Versions: 0.10
> Reporter: Adrien Quillet
> Labels: documentation, easyant, patch, reporting
> Original Estimate: 1h
> Remaining Estimate: 1h
>
> 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 {{false}}),
> ** 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 {{""}})
> * 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)
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
