On 7 April 2014 19:59, Benedikt Ritter <brit...@apache.org> wrote: > Thanks for pointing this out. I'm not 100% sure but I think removing the > comment all together will cause a check style error (or find bugs? don't > know). So you would have to suppress that one an document why. Seems easier > to just use the inheritDoc...
If CheckStyle does not handle inherited Javadocs correctly then it ought to be reported as a bug. Findbugs operates on compiled code only so does not care about Javadoc. > > 2014-04-06 23:40 GMT+02:00 sebb <seb...@gmail.com>: > >> On 6 April 2014 11:43, <brit...@apache.org> wrote: >> > Author: britter >> > Date: Sun Apr 6 10:43:47 2014 >> > New Revision: 1585282 >> > >> > URL: http://svn.apache.org/r1585282 >> > Log: >> > No need to repeat JavaDoc of hashCode method >> > >> > Modified: >> > >> commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java >> > >> > Modified: >> commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java >> > URL: >> http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java?rev=1585282&r1=1585281&r2=1585282&view=diff >> > >> ============================================================================== >> > --- >> commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java >> (original) >> > +++ >> commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java >> Sun Apr 6 10:43:47 2014 >> > @@ -284,9 +284,7 @@ public class ExtendedMessageFormat exten >> > } >> > >> > /** >> > - * Return the hashcode. >> > - * >> > - * @return the hashcode >> > + * {@inheritDoc} >> > */ >> >> AFAIK there's no need to use @inheritdoc on its own. >> AIUI the point of @inheritdoc is to import the parent doc and >> supplement it locally. >> >> If there is nothing to add, then one can leave out the Javadoc block >> entirely. >> >> > @SuppressWarnings( "deprecation" ) // ObjectUtils.hashCode(Object) >> has been deprecated in 3.2 >> > @Override >> > >> > >> >> --------------------------------------------------------------------- >> To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org >> For additional commands, e-mail: dev-h...@commons.apache.org >> >> > > > -- > http://people.apache.org/~britter/ > http://www.systemoutprintln.de/ > http://twitter.com/BenediktRitter > http://github.com/britter --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org For additional commands, e-mail: dev-h...@commons.apache.org
