motiejus
/
jgit
1
Fork 0
Code Releases Activity

Document RevTag#getObject() that returned object is unparsed 

Change-Id: I238d388e40362721eecf37f64ad7d48a399ff129
This commit is contained in:
Robin Stocker 2013-04-22 18:22:18 +02:00
parent 60f0eb748c
commit 3699ea648e
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevTag.java
View File

@ -240,8 +240,16 @@ public final String getShortMessage() {
/**
* 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;