aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRonald Bhuleskar <funronald@google.com>2022-08-05 12:59:39 -0700
committerTerry Parker <tparker@google.com>2022-08-17 19:16:45 -0400
commit1a2aa740c8aa43db7f609dd6b26b2f6dbc075062 (patch)
treef990f32ef183a633cac7c6123cdff22d9496e97e
parent5747bba48b22a11beba8ebe0caf13a53d4ca96f2 (diff)
downloadjgit-1a2aa740c8aa43db7f609dd6b26b2f6dbc075062.tar.gz
jgit-1a2aa740c8aa43db7f609dd6b26b2f6dbc075062.zip
Add javadoc on RevCommit
Change-Id: Ib413154fe52983286cb6307862a7373af4fec6e8
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevCommit.java5
1 files changed, 5 insertions, 0 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevCommit.java b/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevCommit.java
index 7f1e887074..a7c21e3f13 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevCommit.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevCommit.java
@@ -36,6 +36,11 @@ import org.eclipse.jgit.util.StringUtils;
/**
* A commit reference to a commit in the DAG.
+ *
+ * The state of the RevCommit isn't populated until the commit is parsed. The
+ * newly created RevCommit is unparsed and only has an objectId reference. Other
+ * states like parents, trees, commit ident, commit message, etc. are
+ * populated/available when the commit is parsed.
*/
public class RevCommit extends RevObject {
private static final int STACK_DEPTH = 500;