You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Brett Porter (JIRA)" <ji...@codehaus.org> on 2006/03/10 03:43:23 UTC
[jira] Closed: (MNG-1479) Improve pom annotations to create a great
reference
[ http://jira.codehaus.org/browse/MNG-1479?page=all ]
Brett Porter closed MNG-1479:
-----------------------------
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: Brett Porter
> 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