diff options
| author | punkymaniac <punkymaniac@protonmail.ch> | 2021-04-21 15:34:50 +0200 |
|---|---|---|
| committer | punkymaniac <punkymaniac@protonmail.ch> | 2021-04-22 15:07:32 +0200 |
| commit | 51cb439006650fc429bd95690c89c7d18ecf7eb0 (patch) | |
| tree | da7146da4fcacf561912aa67da824fdf81831543 /include | |
| parent | cabfa3b30cfae24ec6d7d75c5cf052e052cbf131 (diff) | |
| download | libgit2-51cb439006650fc429bd95690c89c7d18ecf7eb0.tar.gz | |
Fix documentation formatting
The return code description use '-' char as list of return value.
But with the generation of the documentation the char '-' create an
ambiguous return code value who seem an negative value.
Diffstat (limited to 'include')
| -rw-r--r-- | include/git2/odb.h | 21 |
1 files changed, 8 insertions, 13 deletions
diff --git a/include/git2/odb.h b/include/git2/odb.h index c4bfa5290..ead67ca9c 100644 --- a/include/git2/odb.h +++ b/include/git2/odb.h @@ -94,9 +94,8 @@ GIT_EXTERN(void) git_odb_free(git_odb *db); * @param out pointer where to store the read object * @param db database to search for the object in. * @param id identity of the object to read. - * @return - * - 0 if the object was read; - * - GIT_ENOTFOUND if the object is not in the database. + * @return 0 if the object was read, GIT_ENOTFOUND if the object is + * not in the database. */ GIT_EXTERN(int) git_odb_read(git_odb_object **out, git_odb *db, const git_oid *id); @@ -122,10 +121,9 @@ GIT_EXTERN(int) git_odb_read(git_odb_object **out, git_odb *db, const git_oid *i * @param db database to search for the object in. * @param short_id a prefix of the id of the object to read. * @param len the length of the prefix - * @return - * - 0 if the object was read; - * - GIT_ENOTFOUND if the object is not in the database. - * - GIT_EAMBIGUOUS if the prefix is ambiguous (several objects match the prefix) + * @return 0 if the object was read, GIT_ENOTFOUND if the object is not in the + * database. GIT_EAMBIGUOUS if the prefix is ambiguous + * (several objects match the prefix) */ GIT_EXTERN(int) git_odb_read_prefix(git_odb_object **out, git_odb *db, const git_oid *short_id, size_t len); @@ -143,9 +141,8 @@ GIT_EXTERN(int) git_odb_read_prefix(git_odb_object **out, git_odb *db, const git * @param type_out pointer where to store the type * @param db database to search for the object in. * @param id identity of the object to read. - * @return - * - 0 if the object was read; - * - GIT_ENOTFOUND if the object is not in the database. + * @return 0 if the object was read, GIT_ENOTFOUND if the object is not + * in the database. */ GIT_EXTERN(int) git_odb_read_header(size_t *len_out, git_object_t *type_out, git_odb *db, const git_oid *id); @@ -154,9 +151,7 @@ GIT_EXTERN(int) git_odb_read_header(size_t *len_out, git_object_t *type_out, git * * @param db database to be searched for the given object. * @param id the object to search for. - * @return - * - 1, if the object was found - * - 0, otherwise + * @return 1 if the object was found, 0 otherwise */ GIT_EXTERN(int) git_odb_exists(git_odb *db, const git_oid *id); |
