Konrad Windszus created MPLUGIN-417:
---------------------------------------

             Summary: Clarify plugin descriptor's description element
                 Key: MPLUGIN-417
                 URL: https://issues.apache.org/jira/browse/MPLUGIN-417
             Project: Maven Plugin Tools
          Issue Type: Improvement
          Components: Metadata Model
            Reporter: Konrad Windszus


Currently it is not 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 javadoc-specific tag (MPLUGIN-298) and partially HTML 
specific tags.

As the descriptor is also used as basis for the generated HTML reports the 
format should loose as few details as possible (from the scanned javadoc in 
https://github.com/apache/maven-plugin-tools/blob/50d5679d5a6f93e014645d1b7c790a96edd2e5bf/maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/JavaAnnotationsMojoDescriptorExtractor.java#L253).



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

Reply via email to