[ 
https://issues.apache.org/jira/browse/MPLUGIN-417?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17581851#comment-17581851
 ] 

ASF GitHub Bot commented on MPLUGIN-417:
----------------------------------------

kwin commented on PR #139:
URL: 
https://github.com/apache/maven-plugin-tools/pull/139#issuecomment-1220658423

   > IIRC in the past I've made a change that the two outputs are always based 
on the same source: the plugin descriptor.
   
   The whole point is that this approach prevents emitting the full details. 
Currently the plugin descriptor contains inline taglets (which is wrong) and 
the HTML report does no longer have access to the full context. So in order for 
the report to not go via
   
   `(parse source file information -> convert javadoc to html -> convert html 
to plaintext -> serialize descriptor) -> (deserialize descriptor -> convert 
plain text to html)`
   (while the former block being goal `descriptor` and the latter being 
`report`) you have to do the parsing twice.




> report and descriptor goal need to evaluate Javadoc comments differently
> ------------------------------------------------------------------------
>
>                 Key: MPLUGIN-417
>                 URL: https://issues.apache.org/jira/browse/MPLUGIN-417
>             Project: Maven Plugin Tools
>          Issue Type: Improvement
>          Components: Plugin Plugin
>            Reporter: Konrad Windszus
>            Priority: Major
>
> Currently it is not explicitly specified in 
> https://maven.apache.org/ref/3.8.4/maven-plugin-api/plugin.html which format 
> the {{description}} field on plugin, mojo and parameter level should have.
> It partially contains HTML tags (also from converted inline javadoc taglets) 
> which is problematic for 
> https://maven.apache.org/plugins/maven-help-plugin/describe-mojo.html (which 
> expects plain text).
> On the other hand, the same plugin descriptor is currently leveraged for goal 
> `report` which should include all those HTML details from the source comment.
> Therefore both goals need to extract metadata from source files differently 
> and `report` can no longer rely on the previously generated plugin descriptor 
> file.
> In addition even the plain text descriptor should contain as many details as 
> possible, i.e. it should be converted javadoc taglets -> html -> plain text 
> to no loose any detail.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to