Browse Source

Improve class documentation of TagCommand

Change-Id: I9c636b927fa2d7cfbe1eb5535a9e702b2209f51d
stable-3.0
Robin Stocker 12 years ago
parent
commit
60f0eb748c
  1. 17
      org.eclipse.jgit/src/org/eclipse/jgit/api/TagCommand.java

17
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. * and other copyright owners as documented in the project's IP log.
* *
* This program and the accompanying materials are made available * 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; import org.eclipse.jgit.revwalk.RevWalk;
/** /**
* A class used to execute a {@code Tag} command. It has setters for all * Create/update an annotated tag object.
* supported options and arguments of this command and a {@link #call()} method * <p>
* to finally execute the command. * Examples (<code>git</code> is a {@link Git} instance):
* <p>
* Create a new annotated tag for the current commit:
*
* <pre>
* git.tag().setName(&quot;v1.0&quot;).setMessage(&quot;First stable release&quot;).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" * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-tag.html"
* >Git documentation about Tag</a> * >Git documentation about Tag</a>

Loading…
Cancel
Save