EVALUATION
Perhaps whenever the standard doclet finds {@inheritDoc}
in the first sentence, it should expand it, parse the first
sentence (using a copy of the algorithm that the Doclet API uses)
and then use that instead of the first sentence handed to
it by the Doclet API.
neal.gafter replied:
Reasonable, except it must be done without copying any code at
all or we risk getting them out of sync.
###@###.### 2002-10-27
I fixed this bug by following Neals advice. When the first sentence starts with {@inheritDoc}, inherit the first sentence and ignore the text that follows {@inheritDoc}. There is no need to insert a period after {@inheritDoc} to make it work.
Using {@inheritDoc} without a period probably causes a "first sentence break iterator" warning though. We will have to do something about this in the next release.
###@###.### 2002-12-09
FYI, this bug was introduced in 1.4.1. This bug does not show up at
all in the J2SE API docs, because {@inheritDoc} is not used in the docs
(I did a grep). It only appears in documentation that uses {@inheritDoc}.
###@###.### 2002-12-11
FYI, this bug is still in the FIP state because it was fixed during our tiger refactoring. After the doclet toolkit is reviewed, this bug fix will be putback.
###@###.### 2003-07-01
I don't think this bug has been fixed, or there is a deep
misunderstanding.
The two following javadoc comments:
/**
*
*/
and
/**
* {@inheritDoc}
*/
when applied to an overriding method definition should have
identical effects. However, if the overridden method
"description" consists of more than one sentence, then the
"first sentence" of the first doc comment above is the
same as the "first sentence" of the overriden method (correct),
while the "first sentence" of the second doc comment is the
entire "description" of the overridden method (incorrect).
###@###.### 2005-04-08 23:26:02 GMT
I've understood the nature of the failure I was seeing;
I think this is a slightly different bug; so I'll reset this to
Fix Delivered and will file a new bug.
###@###.### 2005-04-11 21:38:58 GMT
|