diff options
Diffstat (limited to 'org.eclipse.jgit')
| -rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevTag.java | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevTag.java b/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevTag.java index 269b6c104f..12693a03e2 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevTag.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevTag.java @@ -240,8 +240,16 @@ public class RevTag extends RevObject { /** * Get a reference to the object this tag was placed on. + * <p> + * Note that the returned object has only been looked up (see + * {@link RevWalk#lookupAny(AnyObjectId, int)}. To access the contents it + * needs to be parsed, see {@link RevWalk#parseHeaders(RevObject)} and + * {@link RevWalk#parseBody(RevObject)}. + * <p> + * As an alternative, use {@link RevWalk#peel(RevObject)} and pass this + * {@link RevTag} to peel it until the first non-tag object. * - * @return object this tag refers to. + * @return object this tag refers to (only looked up, not parsed) */ public final RevObject getObject() { return object; |