diff options
| author | Robin Stocker <robin@nibor.org> | 2013-04-22 15:35:10 +0200 |
|---|---|---|
| committer | Robin Stocker <robin@nibor.org> | 2013-04-22 15:35:26 +0200 |
| commit | 60f0eb748ca7fa0efd28018b9fa30b95deac29f8 (patch) | |
| tree | 18ce6ebc31903ece0bab6375f742bfd2f8c209d9 | |
| parent | 1b4320f1fa46169ad08a1d3d40ca00a4224881cd (diff) | |
| download | jgit-60f0eb748ca7fa0efd28018b9fa30b95deac29f8.tar.gz jgit-60f0eb748ca7fa0efd28018b9fa30b95deac29f8.zip | |
Improve class documentation of TagCommand
Change-Id: I9c636b927fa2d7cfbe1eb5535a9e702b2209f51d
| -rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/api/TagCommand.java | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/TagCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/TagCommand.java index 1784acd79b..3b1fe88409 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/TagCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/TagCommand.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2010, Chris Aniszczyk <caniszczyk@gmail.com> + * Copyright (C) 2010, 2013 Chris Aniszczyk <caniszczyk@gmail.com> * and other copyright owners as documented in the project's IP log. * * This program and the accompanying materials are made available @@ -66,9 +66,18 @@ import org.eclipse.jgit.revwalk.RevObject; import org.eclipse.jgit.revwalk.RevWalk; /** - * A class used to execute a {@code Tag} command. It has setters for all - * supported options and arguments of this command and a {@link #call()} method - * to finally execute the command. + * Create/update an annotated tag object. + * <p> + * Examples (<code>git</code> is a {@link Git} instance): + * <p> + * Create a new annotated tag for the current commit: + * + * <pre> + * git.tag().setName("v1.0").setMessage("First stable release").call(); + * </pre> + * <p> + * Use {@link Repository#updateRef(String)} to create a lightweight tag (just a + * named reference to a commit). * * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-tag.html" * >Git documentation about Tag</a> |