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 2016/07/25 15:49:20 UTC

[jira] [Updated] (MPLUGIN-298) The plugin descriptor generated by plugin:descriptor removes some javadoc tags

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

Konrad Windszus updated MPLUGIN-298:
------------------------------------
    Summary: The plugin descriptor generated by plugin:descriptor removes some javadoc tags  (was: The plugin descriptor generated plugin:descriptor removes some javadoc tags)

> The plugin descriptor generated by plugin:descriptor removes some javadoc tags
> ------------------------------------------------------------------------------
>
>                 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
>
> 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).
> Some javadoc tags are stripped here and others are just ending up in the plugin descriptor.
> E.g. the see tags are completely ignored which means that this javadoc on the Mojo class itself
> {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}
> The see tags are completely ignored.
> 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
(v6.3.4#6332)