nutch-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Doug Cutting <cutt...@nutch.org>
Subject Re: svn commit: r357334 - in /lucene/nutch/trunk: conf/nutch-default.xml src/java/org/apache/nutch/protocol/Content.java src/java/org/apache/nutch/protocol/ContentProperties.java
Date Sat, 17 Dec 2005 16:14:23 GMT
jerome@apache.org wrote:
> +    /*
> +     * (non-Javadoc)
> +     * 
> +     * @see org.apache.nutch.io.Writable#write(java.io.DataOutput)
> +     */
> +    public final void write(DataOutput out) throws IOException {

We should either include javadoc or not.  In general, all public methods 
should have javadoc.  In this case, since this is implementing an 
interface method, if no Javadoc comment is added, then the interface's 
will be used.  That would be preferable.  Frequently in this case folks 
add a comment like:

// javadoc inherited

Doug

Mime
View raw message