Bug 153399 - [javadoc] JDT Core should warn if the @value tag is not used correctly
Summary: [javadoc] JDT Core should warn if the @value tag is not used correctly
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.2   Edit
Hardware: PC Windows XP
: P3 normal with 1 vote (vote)
Target Milestone: 3.3 M4   Edit
Assignee: Frederic Fusier CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-08-10 03:32 EDT by Dani Megert CLA
Modified: 2006-12-12 06:51 EST (History)
1 user (show)

See Also:

Attachments
Proposed patch (27.12 KB, patch)
2006-11-17 11:14 EST, Frederic Fusier CLA 		no flags Details | Diff
View All 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 Dani Megert CLA 2006-08-10 03:32:31 EDT 
I20060810-0010.

JDT Core should warn if the @value tag is not used correctly, e.g. if in 1.4 the tag is used anywhere else than a constant. Otherwise developers see no Javadoc problem inside Eclipse but then get burned by the 'javadoc' tool with:
  warning - Inline tag {@value} should only be used with a constant field.

See also bug 144866 which should be revisited.

Also note that the @value tag usage changed with 5.0:
http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/javadoc.html#@value
Comment 1 Frederic Fusier CLA 2006-11-17 11:14:48 EST 
Created attachment 54078 [details]
Proposed patch
Comment 2 Frederic Fusier CLA 2006-11-17 11:20:46 EST 
Released for 3.3 M4 in HEAD stream.
Comment 3 David Audel CLA 2006-12-12 06:51:22 EST 
Verified for 3.3M4 with I20061212-0010.