Add better javadoc to the git-init ant task

Change-Id: If41e5a9ab37533cce10ea1c1925d7bd3ece586ea
Signed-off-by: Chris Aniszczyk <caniszczyk@gmail.com>

diff --git a/org.eclipse.jgit.ant/src/org/eclipse/jgit/ant/tasks/GitInitTask.java b/org.eclipse.jgit.ant/src/org/eclipse/jgit/ant/tasks/GitInitTask.java
index 97eb51d989487d78a0a2121d65b648abbba215ea..cab45e0c0960a52453a5dd8c4d854c77e049ab57 100644 (file)
--- a/org.eclipse.jgit.ant/src/org/eclipse/jgit/ant/tasks/GitInitTask.java
+++ b/org.eclipse.jgit.ant/src/org/eclipse/jgit/ant/tasks/GitInitTask.java
@@ -49,13 +49,22 @@ import org.apache.tools.ant.Task;
 import org.eclipse.jgit.api.Git;
 import org.eclipse.jgit.api.InitCommand;
 
+/**
+ * Create an empty git repository.
+ *
+ * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-init.html"
+ *      >git-init(1)</a>
+ */
 public class GitInitTask extends Task {
        private File destination;
        private boolean bare;
 
        /**
+        * Set the destination git repository.
+        *
         * @param dest
-        *            the directory to init to
+        *            the destination directory that should be initialized with the
+        *            git repository.
         */
        public void setDest(File dest) {
                this.destination = dest;
@@ -63,7 +72,8 @@ public class GitInitTask extends Task {
 
        /**
         * @param bare
-        *            whether the repository is bare or not
+        *            whether the repository should be initialized to a bare
+        *            repository or not.
         */
        public void setBare(boolean bare) {
                this.bare = bare;