Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

#526 Ignore missing tags in overriding javadoc comments

Future
open
nobody
Check (274)
5
2012-10-10
2009-08-12
Yoni Tsafir
No

If I do not write any javadoc at all on an overriding method - checkstyle won't bug me about it.
However, if i write a javadoc with only explaining the difference between the overriding method and the original one in the base class, with a @see tag for linking to full javadoc, I don't want to have to write all the @param, @return and @throw tags again (it will be copy-paste basically).

BTW, in eclipse's javadoc compiler configuration - you can avoid this - by unchecking "Check overriding and implementing methods"

I searched and didn't really find a way I can do this in checkstyle.

Discussion

  • Johan Walles
    Johan Walles
    2010-03-24

    I too suffer from this, and having it fixed would enable us to switch on Javadoc comment requirements.

    Thanks! /J