maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Herve Boutemy (JIRA)" <j...@codehaus.org>
Subject [jira] (MPLUGIN-243) add an option to hide a mojo parameter from generated documentation
Date Tue, 03 Dec 2013 07:52:45 GMT

    [ https://jira.codehaus.org/browse/MPLUGIN-243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=336640#comment-336640
] 

Herve Boutemy commented on MPLUGIN-243:
---------------------------------------

a thought on this: marking fields to be completely ignored should be more consistent, ie not
injected (added to the mojo descriptor) and not documented

then something like @Mojo( ignoreFields = { "field1", "field2" } )
                
> add an option to hide a mojo parameter from generated documentation
> -------------------------------------------------------------------
>
>                 Key: MPLUGIN-243
>                 URL: https://jira.codehaus.org/browse/MPLUGIN-243
>             Project: Maven Plugin Tools
>          Issue Type: Improvement
>          Components: maven-plugin-annotations, maven-plugin-tools-annotations, maven-plugin-tools-java,
maven-plugin-tools-javadoc
>    Affects Versions: 3.2
>            Reporter: Herve Boutemy
>            Priority: Minor
>             Fix For: 3.3
>
>
> when a parameter is defined in a parent mojo, because it needs to be shared by some child
mojos, but some other child mojos don't use the feature, parameter documentation just adds
unnecessary complexity
> see MDEP-413 for such an example

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message