Commit b51eb250 by Shawn O. Pearce

Cleanup git_odb documentation formatting

Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
parent 171aaf21
...@@ -100,31 +100,43 @@ typedef struct { ...@@ -100,31 +100,43 @@ typedef struct {
/** /**
* Read a small object from the database. * 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 out object descriptor to populate upon reading.
* @param db database to search for the object in. * @param db database to search for the object in.
* @param id identity of the object to read. * @param id identity of the object to read.
* @return GIT_SUCCESS if the object was read; * @return
* GIT_ENOTFOUND if the object is not in the database. * - 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); 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. * 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 out object descriptor to populate upon reading.
* @param db database to search for the object in. * @param db database to search for the object in.
* @param id identity of the object to read. * @param id identity of the object to read.
* @return GIT_SUCCESS if the object was read; * @return
* GIT_ENOTFOUND if the object is not in the database. * - 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); 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. * 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 out object descriptor to populate upon reading.
* @param db database to search for the object in. * @param db database to search for the object in.
* @param id identity of the object to read. * @param id identity of the object to read.
* @return GIT_SUCCESS if the object was read; * @return
* GIT_ENOTFOUND if the object is not in the database. * - 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); GIT_EXTERN(git_result) git_odb__read_loose(git_sobj *out, git_odb *db, const git_oid *id);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment