You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@forrest.apache.org by Ross Gardler <rg...@apache.org> on 2005/07/05 10:09:43 UTC

Re: svn commit: r209159 - /forrest/trunk/tools/eclipse/plugins/org.apache.forrest/src/org/apache/forrest/eclipse/views/SiteXMLView.java

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