[jira] [Closed] (MPLUGIN-298) The plugin descriptor generated by plugin:descriptor does not consider @see javadoc taglets

["Guillaume Nodet (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/MPLUGIN-298?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Guillaume Nodet closed MPLUGIN-298.
-----------------------------------

> The plugin descriptor generated by plugin:descriptor does not consider @see javadoc taglets
> -------------------------------------------------------------------------------------------
>
>                 Key: MPLUGIN-298
>                 URL: https://issues.apache.org/jira/browse/MPLUGIN-298
>             Project: Maven Plugin Tools
>          Issue Type: Bug
>          Components: Plugin Plugin
>    Affects Versions: 3.4
>            Reporter: Konrad Windszus
>            Priority: Minor
>             Fix For: 3.7.0
>
>
> The description element (1) for both the mojo itself as well as for all parameters is extracted from the Javadoc (of the class respectively the field).
> The block javadoc tags are stripped here while inline javadoc tags are just ending up as is in the plugin descriptor.
> E.g. the see tags are completely ignored which means that this won't appear in the mojo's description:
> {code}
> /**
>  * some text with {@code code-references}
>  * @see <a href="http://example.com">some external source</a>
>  */
> {code}
> will be converted to to the following plugin descriptor
> {code}
> <mojos>
>     <mojo>
>       <goal>...</goal>
>       <description>some text with {@code code-references}</description>
> {code}
> Although it is not documented in (1) it seems that all description elements can deal with (escaped) html tags as well as certain javadoc tags (because those will be automatically stripped from the output being generated by the maven-help-plugin or by the Mojo being generated by {{plugin:helpmojo}}) and automatically considered when the site is being generated from the plugin descriptor. Can you clarify the reference documentation with which tags are supported here and also extend the list of javadoc tags which can be put into those elements
> (1) - https://maven.apache.org/ref/3.3.9/maven-plugin-api/plugin.html



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