Skip to content

Commit 51cb439

Browse files
committed
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.
1 parent cabfa3b commit 51cb439

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

include/git2/odb.h

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,8 @@ GIT_EXTERN(void) git_odb_free(git_odb *db);
9494
* @param out pointer where to store the read object
9595
* @param db database to search for the object in.
9696
* @param id identity of the object to read.
97-
* @return
98-
* - 0 if the object was read;
99-
* - GIT_ENOTFOUND if the object is not in the database.
97+
* @return 0 if the object was read, GIT_ENOTFOUND if the object is
98+
* not in the database.
10099
*/
101100
GIT_EXTERN(int) git_odb_read(git_odb_object **out, git_odb *db, const git_oid *id);
102101

@@ -122,10 +121,9 @@ GIT_EXTERN(int) git_odb_read(git_odb_object **out, git_odb *db, const git_oid *i
122121
* @param db database to search for the object in.
123122
* @param short_id a prefix of the id of the object to read.
124123
* @param len the length of the prefix
125-
* @return
126-
* - 0 if the object was read;
127-
* - GIT_ENOTFOUND if the object is not in the database.
128-
* - GIT_EAMBIGUOUS if the prefix is ambiguous (several objects match the prefix)
124+
* @return 0 if the object was read, GIT_ENOTFOUND if the object is not in the
125+
* database. GIT_EAMBIGUOUS if the prefix is ambiguous
126+
* (several objects match the prefix)
129127
*/
130128
GIT_EXTERN(int) git_odb_read_prefix(git_odb_object **out, git_odb *db, const git_oid *short_id, size_t len);
131129

@@ -143,9 +141,8 @@ GIT_EXTERN(int) git_odb_read_prefix(git_odb_object **out, git_odb *db, const git
143141
* @param type_out pointer where to store the type
144142
* @param db database to search for the object in.
145143
* @param id identity of the object to read.
146-
* @return
147-
* - 0 if the object was read;
148-
* - GIT_ENOTFOUND if the object is not in the database.
144+
* @return 0 if the object was read, GIT_ENOTFOUND if the object is not
145+
* in the database.
149146
*/
150147
GIT_EXTERN(int) git_odb_read_header(size_t *len_out, git_object_t *type_out, git_odb *db, const git_oid *id);
151148

@@ -154,9 +151,7 @@ GIT_EXTERN(int) git_odb_read_header(size_t *len_out, git_object_t *type_out, git
154151
*
155152
* @param db database to be searched for the given object.
156153
* @param id the object to search for.
157-
* @return
158-
* - 1, if the object was found
159-
* - 0, otherwise
154+
* @return 1 if the object was found, 0 otherwise
160155
*/
161156
GIT_EXTERN(int) git_odb_exists(git_odb *db, const git_oid *id);
162157

0 commit comments

Comments
 (0)