Cleanup git_odb documentation formatting

Signed-off-by: Shawn O. Pearce <spearce@spearce.org>

1 files changed, 18 insertions, 6 deletions

diff --git a/src/git_odb.h b/src/git_odb.h
index 556c36fd1..e815adf58 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);