diff options
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/api/StashCreateCommand.java')
| -rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/api/StashCreateCommand.java | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/StashCreateCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/StashCreateCommand.java index 77a7fffb70..3495ff8a9d 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/StashCreateCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/StashCreateCommand.java @@ -115,6 +115,7 @@ public class StashCreateCommand extends GitCommand<RevCommit> { * Create a command to stash changes in the working directory and index * * @param repo + * a {@link org.eclipse.jgit.lib.Repository} object. */ public StashCreateCommand(Repository repo) { super(repo); @@ -128,6 +129,7 @@ public class StashCreateCommand extends GitCommand<RevCommit> { * id, and short commit message when used. * * @param message + * the stash message * @return {@code this} */ public StashCreateCommand setIndexMessage(String message) { @@ -142,6 +144,7 @@ public class StashCreateCommand extends GitCommand<RevCommit> { * id, and short commit message when used. * * @param message + * the working directory message * @return {@code this} */ public StashCreateCommand setWorkingDirectoryMessage(String message) { @@ -153,6 +156,8 @@ public class StashCreateCommand extends GitCommand<RevCommit> { * Set the person to use as the author and committer in the commits made * * @param person + * the {@link org.eclipse.jgit.lib.PersonIdent} of the person who + * creates the stash. * @return {@code this} */ public StashCreateCommand setPerson(PersonIdent person) { @@ -161,12 +166,13 @@ public class StashCreateCommand extends GitCommand<RevCommit> { } /** - * Set the reference to update with the stashed commit id - * If null, no reference is updated + * Set the reference to update with the stashed commit id If null, no + * reference is updated * <p> - * This value defaults to {@link Constants#R_STASH} + * This value defaults to {@link org.eclipse.jgit.lib.Constants#R_STASH} * * @param ref + * the name of the {@code Ref} to update * @return {@code this} */ public StashCreateCommand setRef(String ref) { @@ -178,6 +184,7 @@ public class StashCreateCommand extends GitCommand<RevCommit> { * Whether to include untracked files in the stash. * * @param includeUntracked + * whether to include untracked files in the stash * @return {@code this} * @since 3.4 */ @@ -232,11 +239,10 @@ public class StashCreateCommand extends GitCommand<RevCommit> { } /** + * {@inheritDoc} + * <p> * Stash the contents on the working directory and index in separate commits * and reset to the current HEAD commit. - * - * @return stashed commit or null if no changes to stash - * @throws GitAPIException */ @Override public RevCommit call() throws GitAPIException { |