[ http://jira.codehaus.org/browse/MNG-1479?page=all ]
Jeff Jensen updated MNG-1479:
-----------------------------
Attachment: MNG1479-1.patch
Added a little info to descriptions for:
- packaging element
- relativePath
- scope (added "system" to types list)
- systemPath
> 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
> 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/[EMAIL
> PROTECTED])
--
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: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
