Improve Javadoc for typeHint parameter

Link to an example type constant.

Change-Id: I214ab834fa02901a38e6048a94a5224b30c5d93f
Signed-off-by: Robin Stocker <robin@nibor.org>

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectDatabase.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectDatabase.java
index 15d118c0e97a5b6de2d55a00d18c9c51f43dadf1..0cc51d1a52d9da2ba50890dd59412ee6ba52769e 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectDatabase.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectDatabase.java
@@ -156,9 +156,10 @@ public abstract class ObjectDatabase {
         * @param objectId
         *            identity of the object to open.
         * @param typeHint
-        *            hint about the type of object being requested;
-        *            {@link ObjectReader#OBJ_ANY} if the object type is not known,
-        *            or does not matter to the caller.
+        *            hint about the type of object being requested, e.g.
+        *            {@link Constants#OBJ_BLOB}; {@link ObjectReader#OBJ_ANY} if
+        *            the object type is not known, or does not matter to the
+        *            caller.
         * @return a {@link ObjectLoader} for accessing the object.
         * @throws MissingObjectException
         *             the object does not exist.

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectReader.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectReader.java
index 3bd02500cca4203a74a7a44a834ab23a90fb1262..58c141870b5b6bc4433d162852692a15692799c5 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectReader.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectReader.java
@@ -194,9 +194,9 @@ public abstract class ObjectReader {
         * @param objectId
         *            identity of the object to test for existence of.
         * @param typeHint
-        *            hint about the type of object being requested;
-        *            {@link #OBJ_ANY} if the object type is not known, or does not
-        *            matter to the caller.
+        *            hint about the type of object being requested, e.g.
+        *            {@link Constants#OBJ_BLOB}; {@link #OBJ_ANY} if the object
+        *            type is not known, or does not matter to the caller.
         * @return true if the specified object is stored in this database.
         * @throws IncorrectObjectTypeException
         *             typeHint was not OBJ_ANY, and the object's actual type does
@@ -235,9 +235,9 @@ public abstract class ObjectReader {
         * @param objectId
         *            identity of the object to open.
         * @param typeHint
-        *            hint about the type of object being requested;
-        *            {@link #OBJ_ANY} if the object type is not known, or does not
-        *            matter to the caller.
+        *            hint about the type of object being requested, e.g.
+        *            {@link Constants#OBJ_BLOB}; {@link #OBJ_ANY} if the object
+        *            type is not known, or does not matter to the caller.
         * @return a {@link ObjectLoader} for accessing the object.
         * @throws MissingObjectException
         *             the object does not exist.
@@ -323,9 +323,9 @@ public abstract class ObjectReader {
         * @param objectId
         *            identity of the object to open.
         * @param typeHint
-        *            hint about the type of object being requested;
-        *            {@link #OBJ_ANY} if the object type is not known, or does not
-        *            matter to the caller.
+        *            hint about the type of object being requested, e.g.
+        *            {@link Constants#OBJ_BLOB}; {@link #OBJ_ANY} if the object
+        *            type is not known, or does not matter to the caller.
         * @return size of object in bytes.
         * @throws MissingObjectException
         *             the object does not exist.

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/Repository.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/Repository.java
index 4a352e8b69bf0d5876dc3e0788dc6e955945a29a..77734bf6b1d6c5db788f801904ab0eff01d43b61 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/Repository.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/Repository.java
@@ -257,9 +257,10 @@ public abstract class Repository {
         * @param objectId
         *            identity of the object to open.
         * @param typeHint
-        *            hint about the type of object being requested;
-        *            {@link ObjectReader#OBJ_ANY} if the object type is not known,
-        *            or does not matter to the caller.
+        *            hint about the type of object being requested, e.g.
+        *            {@link Constants#OBJ_BLOB}; {@link ObjectReader#OBJ_ANY} if
+        *            the object type is not known, or does not matter to the
+        *            caller.
         * @return a {@link ObjectLoader} for accessing the object.
         * @throws MissingObjectException
         *             the object does not exist.