Java Solaris Communities Sun Store Join SDN My Profile Why Join?
 
Bug Database
Bug Detail
Quick Lists
Top 25 Bugs
Top 25 RFE's
Recently Closed Bugs
Printable Page Printable Page


Bug Database
Bug ID: 5033234
Votes 0
Synopsis {@inheritDoc} expanded as single sentence
Category doclet:tbd
Reported Against 1.4.2
Release Fixed
State 11-Closed, duplicate of 4767038, bug
Priority: 3-Medium
Related Bugs 4767038
Submit Date 16-APR-2004
Description
if the documentation of an overloading method inherits the overloaded method's doc by starting with {@inheritDoc} then all the inherited text is treated as the first sentence (and the first sentence of the following text, unless one adds an extraneous (and visible) . of <p/> after {@inheritDoc}.

As a result, all the said text ends-up in the summary of the documentation of the overloading method.

This means that the entire doc of the overloaded method plus some shows in the summary.

Jean-  xxxxx@xxxxx   2004-04-16
Work Around
Partial:

- use @inheritDoc (without the {}), but that works only if there's no text to follow.
- start with some sentence before {@inheritDoc}, but it does not always make sense; one usually wants the synopsis to be the same than that of the overloaded method.
- use <p/> after {@inheritDoc} to slightly reduce the extent of the damage.


Jean-  xxxxx@xxxxx   2004-04-16
Evaluation
This has been fixed back in Oct. 2003 in 1.5.0 Beta 1:

4767038: first sentence not determined correctly with use of {@inheritDoc}                

Closing as dupe.
  xxxxx@xxxxx   2004-04-16
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang