Document CloneCommand.setDirectory(null) and setGitDir(null) more clearly

Change-Id: I74757ca68eaa941833846a7c8d983b4e996fa207
Signed-off-by: Jonathan Nieder <jrn@google.com>

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java
index 53901f589ca0306c0f9f69a7050f740fc4281283..cd0bf33ea67f11dc73627d31da0340f279aec0fc 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java
@@ -346,7 +346,8 @@ public class CloneCommand extends TransportCommand<CloneCommand, Git> {
         * @see URIish#getHumanishName()
         *
         * @param directory
-        *            the directory to clone to
+        *            the directory to clone to, or {@code null} if the directory
+        *            name should be taken from the source uri
         * @return this instance
         * @throws IllegalStateException
         *             if the combination of directory, gitDir and bare is illegal.
@@ -362,7 +363,8 @@ public class CloneCommand extends TransportCommand<CloneCommand, Git> {
 
        /**
         * @param gitDir
-        *            the repository meta directory
+        *            the repository meta directory, or {@code null} to choose one
+        *            automatically at clone time
         * @return this instance
         * @throws IllegalStateException
         *             if the combination of directory, gitDir and bare is illegal.