-
Enhancement
-
Resolution: Duplicate
-
P5
-
None
-
1.2.0
-
generic
-
solaris_2.6
For methods that implement an interface, the DocCheck utility
generates comments of the form:
// implements path.to.NameOfInterface
That's good as far as it goes. Once these comments are added,
JavaDoc and DocCheck have no way to see them, so subsequent
runs contine to report them as errors.
DocCheck has a switch that allows the generated comments to
be turned off -- but using that switch means that if a method
is added at a later date, it won't be found.
A comment of the form /** @inheritsCommentsFrom path.to.TheInterface */
would solve things nicely. JavaDoc could either ignore the
implements clause, or verify that the specified interface is
correct. In either case, the DocCheck utility would know that
the method is properly documented.
(Originally the requested tag was named @implements
-dkramer)
generates comments of the form:
// implements path.to.NameOfInterface
That's good as far as it goes. Once these comments are added,
JavaDoc and DocCheck have no way to see them, so subsequent
runs contine to report them as errors.
DocCheck has a switch that allows the generated comments to
be turned off -- but using that switch means that if a method
is added at a later date, it won't be found.
A comment of the form /** @inheritsCommentsFrom path.to.TheInterface */
would solve things nicely. JavaDoc could either ignore the
implements clause, or verify that the specified interface is
correct. In either case, the DocCheck utility would know that
the method is properly documented.
(Originally the requested tag was named @implements
-dkramer)
- duplicates
-
JDK-4186639 stddoclet: Inherit documentation with {@inheritDoc} tag
-
- Resolved
-