Re: [EGIT PATCH Series] Cleanups and javadocs

From: Roger C. Soares <rogersoares@intelinet.com.br>
Date: Feb 5, 2008, 15:09 UTC
Message-ID: <47A87C26.2070307@intelinet.com.br>
In-Reply-To: <1202170534-15788-1-git-send-email-robin.rosenberg@dewire.com>

Robin Rosenberg escreveu:

Show 10 quoted lines

> Here is a number of small enhancements that reduce the number of warnings
> displayed and raises the standard on comments. We now get javadoc comments
> on all public and protected methods which hopefully will make it slighly
> easier to get on the train for those interested in helping out with Egit/Jgit.
>
> Disabling the else-warning is probably fairly uncontroversial. Disabling some
> warning about boxing/unboxing of integers might be as might be requiring
> javadoc comments.
>
>

Hi Robin,

[2, 3, 5 and 6] - looks fine to me.

[1] - What about something like "nothing to be done here" and/or "implementing interface method"?

[4] - Some typos:
+     * Construct an GitStorage instance corresponding to
+     * Construct a GitTag object with a give name.
+     * with some filtering applied. The filter could reduces the number of
+     * commitgs returned or just mark some versions as interesting.
+     *            true if all revisions are returned and interesting 
revisiosn.
+ * An class for changing a ref and possibly index and workdir too.
+     * Construct a {@link CheckpointJob} for the specified resource maping
+     * Drop the Eclipse project from our assocation of 
projects/repositories

And
+    /**
+     * Maps the commit id of this object and
+     *
+     * @return the {@link Commit} object this {@link IFileRevision} 
refers to
+     */
and what?

[]s, Roger.