Community
Participate
Working Groups
I created API use reports (consumer and producer based) from an API use scan. In both cases the ant tasks provided a "description" attribute, but the description appeared empty in the HTML output. Example target: <target name="Consumer Report" description="Geneates consumer based report"> <apitooling.apiconsumer_reportconversion xmlfiles="${xmlDir}" htmlfiles="${consumerDir}" description="This Is Just A Test" /> </target>
Created attachment 181743 [details] HTML page
I'll fix it.
I think this is invalid. The description passed to the apitooling.apiconsumer_reportconversion task is not the one that ends up being generated in the report. In the report, the description should come from the xml report. Did I miss something ? The method setDescription(..) used in this case is: org.apache.tools.ant.ProjectComponent.setDescription(String)
Note: I added the description field to the report conversion targets cause the Ant Editor gave me code assist for it... perhaps this is an Ant Editor bug if the attribute is not supported on the report conversion tasks.
I think you would need the setDescription(..) method to be used when the xml file was created, not when it is converted to html.
The documentation for the tasks does not list description as a parameter for either the use task or the report conversion task. The parameter probably should not be available on the report task, as Olivier pointed out the description should be coming from the xml. However, I would have expected the description element in the xml to be taken from a parameter.
If you want the description from the apitooling.apiconsumer_reportconversion ant task over the description inside the xml report, it must be clearly described. This would be easy to fix. I just want to make sure this is exactly what you want. What description should be dumped into the html report if the xml report has a description and the ant task has a description ?
Closing as INVALID as the description for the ant task should not have any effect on the description dumped into the html report. The description inside the html report must come from the description saved inside the xml report.
