aboutsummaryrefslogtreecommitdiffstats
path: root/org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java
diff options
context:
space:
mode:
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java')
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java6
1 files changed, 4 insertions, 2 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java b/org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java
index ce8995ad8f..e5559dea09 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java
@@ -144,7 +144,8 @@ public class SubmoduleWalk implements AutoCloseable {
* path and .gitmodules at the root.
* @param path
* a {@link java.lang.String} object.
- * @return generator at given path, null if no submodule at given path
+ * @return generator at given path. The caller is responsible for calling
+ * {@link #close()}. Null if no submodule at given path.
* @throws java.io.IOException
*/
public static SubmoduleWalk forPath(Repository repository,
@@ -177,7 +178,8 @@ public class SubmoduleWalk implements AutoCloseable {
* path and .gitmodules at the root.
* @param path
* a {@link java.lang.String} object.
- * @return generator at given path, null if no submodule at given path
+ * @return generator at given path. The caller is responsible for calling
+ * {@link #close()}. Null if no submodule at given path.
* @throws java.io.IOException
*/
public static SubmoduleWalk forPath(Repository repository,