Bug 246850 - [javadoc] {@inheritDoc} tag should remove all missing tag warnings
Summary: [javadoc] {@inheritDoc} tag should remove all missing tag warnings
Status: VERIFIED INVALID
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.4   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.5 M2   Edit
Assignee: Frederic Fusier CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-09-10 08:34 EDT by Frederic Fusier CLA
Modified: 2008-09-15 09:59 EDT (History)
2 users (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 Frederic Fusier CLA 2008-09-10 08:34:32 EDT 
3.5M1 but this issue exists since the initial javadoc parsing implementation in 3.0...

It appears that request made for bug 51606 is not valid. Looking at javadoc tool behavior, as soon as the 'inheritedDoc' tag is present in the javadoc, the documentation of overridden method parameters is generated.

Hence, by default the compiler should not inhibits the {@inheritedDoc} tag when it is not in the first text (aka the main description) of the comment.

However, I suggest not to revert abruptly the compiler behavior but add a new preferences instead to let the user decide to show this kind of problem or not...

See also bug 246712 comment 7...
Comment 1 Frederic Fusier CLA 2008-09-12 03:46:11 EDT 
I finally close this bug as INVALID as in fact the Javadoc tool does not rely on the {@inheritDoc} tag to insert description from overridden method. It do it all the time following the algorithm described in the spec:

http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#inheritingcomments

See also bug 246236 for discussion on the missing tag warning vs. {@inheritDoc] tag...
Comment 2 David Audel CLA 2008-09-15 09:59:19 EDT 
Verified for 3.5M2