diff options
| author | Robin Stocker <robin@nibor.org> | 2013-11-13 20:14:16 +0100 |
|---|---|---|
| committer | Robin Stocker <robin@nibor.org> | 2013-11-14 11:12:29 +0100 |
| commit | 04f19353fd95baa86ae3ca184eb52876c5a89250 (patch) | |
| tree | 1bf3d0d8acb6b746684eea97057ffceb47abfb15 | |
| parent | f3b80f1a7417591eb0ad7fa2b212a0588f987441 (diff) | |
| download | jgit-04f19353fd95baa86ae3ca184eb52876c5a89250.tar.gz jgit-04f19353fd95baa86ae3ca184eb52876c5a89250.zip | |
Improve Javadoc for typeHint parameter
Link to an example type constant.
Change-Id: I214ab834fa02901a38e6048a94a5224b30c5d93f
Signed-off-by: Robin Stocker <robin@nibor.org>
3 files changed, 17 insertions, 15 deletions
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 15d118c0e9..0cc51d1a52 100644 --- 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 3bd02500cc..58c141870b 100644 --- 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 4a352e8b69..77734bf6b1 100644 --- 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. |