Code beautifying

[GoogleCodeExporter]

I started integrating gwt-ext into my project. Currently most of the source
files are missing javadocs so I'll try to contribute a bit while Sanjiv can
concentrate on adding new features in.

I'll do the following to the source files:

 * Making lines are below 80 chars in length.
 * Sorting fields, constructors, inner classes, methods.
 * Adding javadoc to methods, fields etc etc.

Please keep this issue open as I'll be submitting patches for reviews.

Original issue reported on code.google.com by ajia...@gmail.com on 4 Aug 2007 at 3:33

[GoogleCodeExporter]

Patch for Size.java. Please notify me if the patch is up to scratch. I'll batch 
up
later submissions if this current one is of good enough standard.

Original comment by ajia...@gmail.com on 4 Aug 2007 at 3:35

Attachments:

• Size.patch

[GoogleCodeExporter]

Thanks for offering to help. I have already started adding javadocs so I'll let 
you
know if I need additional help. Also I don't believe in the 80 char / line 
standard.
Thats a rather old standard based on the DEV VT100 terminal having 80 
characters but
today most monitors are of much higher resolution. I tend to follow the 
guideline of
120 chars / line.

Original comment by sanjiv.j...@gmail.com on 4 Aug 2007 at 4:10

[GoogleCodeExporter]

I've started off adding Javadocs for the data package so if you want to write
Javadocs you can start off with any other package and I'll focus on other 
activities.

I reviewed your patch and wanted to add a couple of points. The comments for the
@param and @return tags should start on the same line as the tag declaration 
but may
continue to the next line if it gets long. Also the comments for @param and 
@return
should start with a lowercase word and not end with a period / dot. Where 
relevant,
the method Javadocs may have a @see tag for a related class after the @param and
@return tags. For example :

    /**
     * Returns the size of the given <code>JavaScriptObject</code>.
     * 
     * @param jsObj the <code>JavaScriptObject</code> of which the size is to be
     *            found out by this method.
     * @return the size of the given <code>JavaScriptObject</code>
     */

You can model the Javadocs based on the Ext documentation
(http://extjs.com/deploy/ext/docs/). We can further refine / polish it as the 
need
arises. It would also be great if when adding Javadocs you make note of any 
methods
missing from GWT-Ext that are present in Ext. You can create a separate issue 
for that.

Original comment by sanjiv.j...@gmail.com on 4 Aug 2007 at 11:17

[GoogleCodeExporter]

Noted. I'll adjust my IDE's settings accordingly.

Original comment by ajia...@gmail.com on 4 Aug 2007 at 4:27

[GoogleCodeExporter]

duplicate of 124

Original comment by sanjiv.j...@gmail.com on 12 Oct 2007 at 1:58

• Changed state: Duplicate