From 6a51d97948a29c262c5b506466425c3169a56947 Mon Sep 17 00:00:00 2001 From: "Shawn O. Pearce" Date: Mon, 23 Aug 2010 09:40:41 -0700 Subject: [PATCH] Add documentation explaining how to read Commit and Tag Since we stopped supporting these types for reading, but their name is a natural candidate for someone to try and use in code, explain where they should be looking instead. Change-Id: I091a1b0ef71b842016020f938ba3161431aab9c9 Signed-off-by: Shawn O. Pearce --- org.eclipse.jgit/src/org/eclipse/jgit/lib/Commit.java | 4 ++++ org.eclipse.jgit/src/org/eclipse/jgit/lib/Tag.java | 4 ++++ 2 files changed, 8 insertions(+) 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 ebf75f92b..8fc46c915 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 fbd22c36b..fda6b1cb1 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;