Bug 246712 - [javadoc] Unexpected warning about missing parameter doc in case of @inheritDoc
Summary: [javadoc] Unexpected warning about missing parameter doc in case of @inheritDoc
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.4   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 3.5 M2   Edit
Assignee: Frederic Fusier CLA
QA Contact:
URL:
Whiteboard:
Keywords:
: 246715 (view as bug list)
Depends on:
Blocks:
 
Reported: 2008-09-09 09:20 EDT by Dani Megert CLA
Modified: 2008-09-15 09:58 EDT (History)
1 user (show)

See Also:

Attachments
Proposed patch (4.57 KB, patch)
2008-09-09 15:11 EDT, Frederic Fusier CLA 		no flags Details | Diff
Additional patch to fix same issue on other tags (6.43 KB, patch)
2008-09-10 04:46 EDT, 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 2008-09-09 09:20:27 EDT 
N20080909-2000.

A wrong warning is issued about missing parameter doc in case of @inheritDoc:

	/**
	 * Do something more.
	 *
	 * {@inheritDoc}
	 *
	 * @param monitor {@inheritDoc}
	 * @return {@link Status#OK_STATUS}
	 */

==> warns that monitor has missing doc.


NOTE: warning must be enabled for all tags.
Comment 1 Frederic Fusier CLA 2008-09-09 10:00:30 EDT 
Look same as bug 246715...
Comment 2 Dani Megert CLA 2008-09-09 10:22:24 EDT 
>Look same as bug 246715...
Almost. However, in case of {@inheritDoc} you must check whether there's indeed a comment that can be inherited.
Comment 3 Frederic Fusier CLA 2008-09-09 10:46:29 EDT 
*** Bug 246715 has been marked as a duplicate of this bug. ***
Comment 4 Frederic Fusier CLA 2008-09-09 10:51:30 EDT 
(In reply to comment #2)
> >Look same as bug 246715...
> Almost. However, in case of {@inheritDoc} you must check whether there's indeed
> a comment that can be inherited.
> 
This is a real duplicate. This bug summary and description was about the unexpected warning... {@inheritDoc} check is another point and needs to be treated in a separate bug.
Comment 5 Frederic Fusier CLA 2008-09-09 15:11:37 EDT 
Created attachment 112119 [details]
Proposed patch
Comment 6 Frederic Fusier CLA 2008-09-09 15:12:01 EDT 
Released for 3.5M2
Comment 7 Dani Megert CLA 2008-09-10 04:31:10 EDT 
>This bug summary and description was about the
>unexpected warning... {@inheritDoc} check is another point and needs to be
>treated in a separate bug.
Is there a bug for it? Really, what I expect is that @inheritDoc is handled correctly - that's all. I didn't expect that just because there are too many warning it isn't handled correctly at all.
Comment 8 Frederic Fusier CLA 2008-09-10 04:46:03 EDT 
Created attachment 112174 [details]
Additional patch to fix same issue on other tags

Previous patch fixes the problem only for @param, @throws and @exception tags. This additional one, released in HEAD, fixes it for all standard tags...
Comment 9 Dani Megert CLA 2008-09-10 06:52:38 EDT 
Verified that the initially reported issue is fixed running on latest code.

Thanks for the fast fix!
Comment 10 David Audel CLA 2008-09-15 09:58:17 EDT 
Verified for 3.5M2 using I20080914-2000