forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Ross Gardler <rgard...@apache.org>
Subject Re: svn commit: r209159 - /forrest/trunk/tools/eclipse/plugins/org.apache.forrest/src/org/apache/forrest/eclipse/views/SiteXMLView.java
Date Tue, 05 Jul 2005 08:09:43 GMT
crossley@apache.org wrote:
> Author: crossley
> Date: Mon Jul  4 17:57:10 2005
> New Revision: 209159

....

>  /**
>   * This sample class demonstrates how to plug-in a new workbench view. The view
> @@ -87,13 +66,15 @@
>   * <p>
>   */

A very important part of documentation for Java code is the Javadoc 
comments. Can we please make sure that the comments are meaningful 
rather than, as is the case here, the default comments created by 
Eclipse. The more detailed they are the better.

This includes editing any Javadocs that are already in SVn but are 
unclear to you as a new reader.

Ross

Mime
View raw message