Bug 227730 - [Javadoc] Missing description should not be warned for {@inheritDoc}
Summary: [Javadoc] Missing description should not be warned for {@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.4 M7   Edit
Assignee: Eric Jodet CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on: 222902
Blocks:
  Show dependency tree
 
Reported: 2008-04-18 05:08 EDT by Martin Oberhuber CLA
Modified: 2008-04-30 04:26 EDT (History)
12 users (show)

See Also:

Attachments
[proposed patch + test case] on top v855 - all jdt.core tests OK (2.36 KB, patch)
2008-04-28 17:15 EDT, Eric Jodet CLA 		no flags Details | Diff
[proposed patch + test case] on top v855 - all jdt.core tests OK (4.33 KB, patch)
2008-04-29 06:28 EDT, Eric Jodet CLA 		no flags Details | Diff
Show Obsolete (1) 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 Martin Oberhuber CLA 2008-04-18 05:08:56 EDT 
+++ This bug was initially created as a clone of Bug #222902 +++

With bug 222902, the feature to warn about missing description of Javadoc tags was changed such that "all standard tags" are warned.

If this feature is enabled, a warning about missing description is generated for the {@inheritDoc} inlined tag. But this tag is specified not to have any description:

http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#{@inheritDoc}

The code should be changed to not warn about missing description for {@inheritDoc}, since this tag is designed not to have any description.
Comment 1 Olivier Thomann CLA 2008-04-18 08:21:25 EDT 
This is not an enhancement. This is a bug.
Comment 2 Eric Jodet CLA 2008-04-28 17:15:56 EDT 
Created attachment 97860 [details]
[proposed patch + test case] on top v855 - all jdt.core tests OK

Removes the unexpected warning for {@inheritDoc} tag.
Also contains corresponding test case: JavadocBugsTest#testBug227730()
Comment 3 Eric Jodet CLA 2008-04-28 17:18:44 EDT 
Patch released in HEAD for 3.4 M7
Comment 4 Eric Jodet CLA 2008-04-29 06:28:45 EDT 
Created attachment 97945 [details]
[proposed patch + test case] on top v855 - all jdt.core tests OK

improved patch + additional test case
Comment 5 Maxime Daniel CLA 2008-04-30 04:26:49 EDT 
Verified for 3.4 M7 using build I20080430-0100.