diff options
| -rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/lib/Commit.java | 4 | ||||
| -rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/lib/Tag.java | 4 |
2 files changed, 8 insertions, 0 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/Commit.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/Commit.java index ebf75f92b9..8fc46c915c 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/Commit.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/Commit.java @@ -54,6 +54,10 @@ import java.util.List; * Applications should use this object when they need to manually construct a * commit and want precise control over its fields. For a higher level interface * see {@link org.eclipse.jgit.api.CommitCommand}. + * + * To read a commit object, construct a {@link org.eclipse.jgit.revwalk.RevWalk} + * and obtain a {@link org.eclipse.jgit.revwalk.RevCommit} instance by calling + * {@link org.eclipse.jgit.revwalk.RevWalk#parseCommit(AnyObjectId)}. */ public class Commit { private static final ObjectId[] EMPTY_OBJECTID_LIST = new ObjectId[0]; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/Tag.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/Tag.java index fbd22c36be..fda6b1cb1b 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/Tag.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/Tag.java @@ -52,6 +52,10 @@ import org.eclipse.jgit.revwalk.RevObject; * * Applications should use this object when they need to manually construct a * tag and want precise control over its fields. + * + * To read a tag object, construct a {@link org.eclipse.jgit.revwalk.RevWalk} + * and obtain a {@link org.eclipse.jgit.revwalk.RevTag} instance by calling + * {@link org.eclipse.jgit.revwalk.RevWalk#parseTag(AnyObjectId)}. */ public class Tag { private ObjectId tagId; |