Bug 51606 - Javadoc - {@inheritDoc} should be inefficient when not in first text element
Summary: Javadoc - {@inheritDoc} should be inefficient when not in first text element
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.0   Edit
Hardware: PC Windows 2000
: P3 normal (vote)
Target Milestone: 3.0 RC1   Edit
Assignee: Frederic Fusier CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2004-02-11 06:13 EST by David Audel CLA
Modified: 2004-05-28 14:48 EDT (History)
0 users

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 David Audel CLA 2004-02-11 06:13:07 EST 
build 20040210
1) enabled Javadoc diagnosis
2) create the following classes
/** */
public class X {
  /**
   * @param a aaa
   * @param b bbb
   */
  public void foo(int a, int b) {
  }
}
/** */
public class Y extends X {
  /**
  *  @param a {@inheritDoc}
   */
  public void foo(int a, int b) {
  }
}

Currently there is no problem. Perhaps an error would be signaled because only 
the doc for param 'a' is inherited.
   "Javadoc - Missing tag for parameter b"
Comment 1 Frederic Fusier CLA 2004-05-18 07:49:31 EDT 
Note that in following sample:
public class Z extends X {
  /**
   * Javadoc description {@inheritDoc}
   *  @param a aaaa
   */
  public void foo(int a, int b) {
  }
}
compiler must continue to filter missing tag warnings...
Comment 2 Frederic Fusier CLA 2004-05-25 06:56:40 EDT 
Fixed.

Verify now that {@inheritedDoc} tag is in doc comment description (ie. first 
tag element without tag name) to inhibits all missing tag warnings.

[jtd-core-internal]
Change done in AbstractCommentParser.parseComment(int,int).
Test cases added in JavadocTestMixed
Comment 3 Olivier Thomann CLA 2004-05-28 14:48:49 EDT 
Verified in 200405281200