summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKetan Padegaonkar <KetanPadegaonkar@gmail.com>2011-05-02 09:44:34 -0700
committerChris Aniszczyk <caniszczyk@gmail.com>2011-05-02 12:22:24 -0500
commitdce5f96c1ee38c7e50584eac61adb6abdd38aca4 (patch)
tree770a80c18811d9d750b67242549d38ff5affbfd6
parent130ecaad6d10bcb11c7e60e043cf66a9d455e51a (diff)
downloadjgit-dce5f96c1ee38c7e50584eac61adb6abdd38aca4.tar.gz
jgit-dce5f96c1ee38c7e50584eac61adb6abdd38aca4.zip
Add better javadoc to the git-init ant task
Change-Id: If41e5a9ab37533cce10ea1c1925d7bd3ece586ea Signed-off-by: Chris Aniszczyk <caniszczyk@gmail.com>
-rw-r--r--org.eclipse.jgit.ant/src/org/eclipse/jgit/ant/tasks/GitInitTask.java14
1 files changed, 12 insertions, 2 deletions
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 97eb51d989..cab45e0c09 100644
--- 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;