Bug 405180 - Update tag documentation
Summary: Update tag documentation
Status: VERIFIED FIXED
Alias: None
Product: PDE
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 4.3   Edit
Hardware: PC Windows 7
: P3 normal (vote)
Target Milestone: 4.3 RC1   Edit
Assignee: Michael Rennie CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2013-04-08 11:26 EDT by Curtis Windatt CLA
Modified: 2013-05-15 12:23 EDT (History)
1 user (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Curtis Windatt CLA 2013-04-08 11:26:42 EDT 
http://help.eclipse.org/juno/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/api_javadoc_tags.htm

The help page describes which tags are valid for what.  This will have to be updated for any changes we make in 4.3 (such as @noreference on types).

We may also want to add a separate section listing the other restrictions we have.  Though the error messages are intended to be descriptive enough.
Comment 1 Michael Rennie CLA 2013-05-15 12:06:15 EDT 
Pushed changes to: http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=fb636e3bf7049167518c2cb6b2e6231d702cae85

to describe how the @noreference tag applies to types and updated the table.

I also created a new wiki page to talk about the tags and how they apply: http://wiki.eclipse.org/PDE/API_Tools/Javadoc_Tags
Comment 2 Curtis Windatt CLA 2013-05-15 12:23:40 EDT 
Looks great.