You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Konrad Windszus (Jira)" <ji...@apache.org> on 2022/08/15 09:13:00 UTC
[jira] [Updated] (MPLUGIN-417) Clarify plugin descriptor's description element
[ https://issues.apache.org/jira/browse/MPLUGIN-417?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Konrad Windszus updated MPLUGIN-417:
------------------------------------
Description:
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 tags (MPLUGIN-298) and partially HTML 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).
was:
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).
> 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
> Priority: Major
>
> 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 tags (MPLUGIN-298) and partially HTML 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)