You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Matthew Beermann (JIRA)" <ji...@codehaus.org> on 2007/08/01 20:03:13 UTC

[jira] Created: (MPLUGIN-35) Generated documentation for @phase is misleading

Generated documentation for @phase is misleading
------------------------------------------------

                 Key: MPLUGIN-35
                 URL: http://jira.codehaus.org/browse/MPLUGIN-35
             Project: Maven 2.x Plugin Plugin
          Issue Type: Bug
    Affects Versions: 2.3
            Reporter: Matthew Beermann
            Priority: Minor
             Fix For: 2.4


If you have the @phase annotation in your mojo, the generated documentation will look something like: "Automatically executes within the lifecycle phase: validate "

This is misleading; the goal will _not_ automatically execute - very few goals in Maven do. Instead, you need an <executions> section in your POM. I think it would be clearer to just say "Executes during the lifecycle phase: validate" or something like that.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (MPLUGIN-35) Generated documentation for @phase is misleading

Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MPLUGIN-35?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_124371 ] 

Dennis Lundberg commented on MPLUGIN-35:
----------------------------------------

I have committed the improved text supplied by Benjamin.

Due to MPLUGIN-75 now being fixed, we should also update the French translation in pluginxdoc_fr.properties. I don't speak French, but I understand enough to see that it needs to be updated. Vincent, can you do that?

> Generated documentation for @phase is misleading
> ------------------------------------------------
>
>                 Key: MPLUGIN-35
>                 URL: http://jira.codehaus.org/browse/MPLUGIN-35
>             Project: Maven 2.x Plugin Tools
>          Issue Type: Bug
>    Affects Versions: 2.3
>            Reporter: Matthew Beermann
>            Priority: Minor
>             Fix For: 2.4
>
>         Attachments: phase-binding.patch
>
>
> If you have the @phase annotation in your mojo, the generated documentation will look something like: "Automatically executes within the lifecycle phase: validate "
> This is misleading; the goal will _not_ automatically execute - very few goals in Maven do. Instead, you need an <executions> section in your POM. I think it would be clearer to just say "Executes during the lifecycle phase: validate" or something like that.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (MPLUGIN-35) Generated documentation for @phase is misleading

Posted by "Benjamin Bentmann (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MPLUGIN-35?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Benjamin Bentmann updated MPLUGIN-35:
-------------------------------------

    Attachment: phase-binding.patch

I think any word about "execute" is misplaced in this context. The {{@phase}} annotation specifies a default binding, not more. Unless the user does not setup an {{<execution>}} nothing happens with such a mojo.

> Generated documentation for @phase is misleading
> ------------------------------------------------
>
>                 Key: MPLUGIN-35
>                 URL: http://jira.codehaus.org/browse/MPLUGIN-35
>             Project: Maven 2.x Plugin Tools
>          Issue Type: Bug
>    Affects Versions: 2.3
>            Reporter: Matthew Beermann
>            Priority: Minor
>             Fix For: 2.4
>
>         Attachments: phase-binding.patch
>
>
> If you have the @phase annotation in your mojo, the generated documentation will look something like: "Automatically executes within the lifecycle phase: validate "
> This is misleading; the goal will _not_ automatically execute - very few goals in Maven do. Instead, you need an <executions> section in your POM. I think it would be clearer to just say "Executes during the lifecycle phase: validate" or something like that.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Closed: (MPLUGIN-35) Generated documentation for @phase is misleading

Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MPLUGIN-35?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Vincent Siveton closed MPLUGIN-35.
----------------------------------

      Assignee: Vincent Siveton
    Resolution: Fixed

Added the French translation

> Generated documentation for @phase is misleading
> ------------------------------------------------
>
>                 Key: MPLUGIN-35
>                 URL: http://jira.codehaus.org/browse/MPLUGIN-35
>             Project: Maven 2.x Plugin Tools
>          Issue Type: Bug
>    Affects Versions: 2.3
>            Reporter: Matthew Beermann
>            Assignee: Vincent Siveton
>            Priority: Minor
>             Fix For: 2.4
>
>         Attachments: phase-binding.patch
>
>
> If you have the @phase annotation in your mojo, the generated documentation will look something like: "Automatically executes within the lifecycle phase: validate "
> This is misleading; the goal will _not_ automatically execute - very few goals in Maven do. Instead, you need an <executions> section in your POM. I think it would be clearer to just say "Executes during the lifecycle phase: validate" or something like that.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira