JDK-5033234 : {@inheritDoc} expanded as single sentence
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.4.2
  • Priority: P3
  • Status: Closed
  • Resolution: Duplicate
  • OS: linux
  • CPU: x86
  • Submitted: 2004-04-16
  • Updated: 2014-05-05
  • Resolved: 2004-04-17
Related Reports
Duplicate :  
JDK-4767038 - first sentence not determined correctly with use of {@inheritDoc}
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.

###@###.### 2004-04-16
Comments
SUGGESTED FIX Should it not expand {@blocks} *before* breaking the first sentence ? ###@###.### 2004-04-16
16-04-2004
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. ###@###.### 2004-04-16
16-04-2004
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. ###@###.### 2004-04-16
16-04-2004