Commit b51eb250ed0cbda59d3108d04569fab9413909fd
2008-10-31T10:55:58
Cleanup git_odb documentation formatting Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
diff --git a/src/git_odb.h b/src/git_odb.h
index 556c36f..e815adf 100644
--- a/src/git_odb.h
+++ b/src/git_odb.h
@@ -100,31 +100,43 @@ typedef struct {
/**
* Read a small object from the database.
+ *
+ * If GIT_ENOTFOUND then out->data is set to NULL.
+ *
* @param out object descriptor to populate upon reading.
* @param db database to search for the object in.
* @param id identity of the object to read.
- * @return GIT_SUCCESS if the object was read;
- * GIT_ENOTFOUND if the object is not in the database.
+ * @return
+ * - GIT_SUCCESS if the object was read;
+ * - GIT_ENOTFOUND if the object is not in the database.
*/
GIT_EXTERN(git_result) git_odb_read(git_sobj *out, git_odb *db, const git_oid *id);
/**
* Read a small object from the database using only pack files.
+ *
+ * If GIT_ENOTFOUND then out->data is set to NULL.
+ *
* @param out object descriptor to populate upon reading.
* @param db database to search for the object in.
* @param id identity of the object to read.
- * @return GIT_SUCCESS if the object was read;
- * GIT_ENOTFOUND if the object is not in the database.
+ * @return
+ * - GIT_SUCCESS if the object was read.
+ * - GIT_ENOTFOUND if the object is not in the database.
*/
GIT_EXTERN(git_result) git_odb__read_packed(git_sobj *out, git_odb *db, const git_oid *id);
/**
* Read a small object from the database using only loose object files.
+ *
+ * If GIT_ENOTFOUND then out->data is set to NULL.
+ *
* @param out object descriptor to populate upon reading.
* @param db database to search for the object in.
* @param id identity of the object to read.
- * @return GIT_SUCCESS if the object was read;
- * GIT_ENOTFOUND if the object is not in the database.
+ * @return
+ * - GIT_SUCCESS if the object was read.
+ * - GIT_ENOTFOUND if the object is not in the database.
*/
GIT_EXTERN(git_result) git_odb__read_loose(git_sobj *out, git_odb *db, const git_oid *id);