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 1784acd79..3b1fe8840 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 + * Copyright (C) 2010, 2013 Chris Aniszczyk * 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. + *

+ * Examples (git is a {@link Git} instance): + *

+ * Create a new annotated tag for the current commit: + * + *

+ * git.tag().setName("v1.0").setMessage("First stable release").call();
+ * 
+ *

+ * Use {@link Repository#updateRef(String)} to create a lightweight tag (just a + * named reference to a commit). * * @see Git documentation about Tag