maven-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Carlos Sanchez (JIRA)" <j...@codehaus.org>
Subject [jira] Closed: (MNG-1479) Improve pom annotations to create a great reference
Date Fri, 20 Jan 2006 19:26:06 GMT
     [ http://jira.codehaus.org/browse/MNG-1479?page=all ]
     
Carlos Sanchez closed MNG-1479:
-------------------------------

     Assign To: Carlos Sanchez
    Resolution: Fixed

> Improve pom annotations to create a great reference
> ---------------------------------------------------
>
>          Key: MNG-1479
>          URL: http://jira.codehaus.org/browse/MNG-1479
>      Project: Maven 2
>         Type: Improvement

>   Components: documentation - general
>     Versions: 2.0
>  Environment: n/a
>     Reporter: Jeff Jensen
>     Assignee: Carlos Sanchez
>      Fix For: documentation
>  Attachments: MNG1479-1.patch
>
>
> Besides the multi-module doc, my experience wishes for the POM entry descriptions - some
are too vague.  More detail (what is it for/why would you use it, how to use it), examples,
valid values, etc. would help a lot.
> I think the project descriptor has big potential as a solid reference vehicle, with the
added info.  I would value that more than many of the "guides".
> For a simple example, the <packaging> element doesn't describe valid values, so
a search begins to learn them.  Viewing the schema doesn't help, as the packaging type is
"string".  Additionally, I think the phrase "type of artifact" is not intuitive to newbies,
so listing the valid values would bring contextual explanation, as well as their definition.
> (from http://mail-archives.apache.org/mod_mbox/maven-users/200511.mbox/%3c1131545979.18047.488.camel@localhost.localdomain%3e)

-- 
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


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Mime
View raw message