proxmox-mirrors/libgit2
1
0
Fork 0
mirror of https://git.proxmox.com/git/libgit2 synced 2025-05-03 13:01:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Cleanup git_odb documentation formatting

Browse Source 
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
This commit is contained in:
Shawn O. Pearce 2008-10-31 10:55:58 -07:00
parent 171aaf21d9
commit b51eb250ed
1 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/git_odb.h
View File

@ -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);