diff options
| -rw-r--r-- | include/git2/commit.h | 3 | ||||
| -rw-r--r-- | include/git2/config.h | 4 | ||||
| -rw-r--r-- | include/git2/object.h | 4 | ||||
| -rw-r--r-- | include/git2/odb.h | 23 | ||||
| -rw-r--r-- | include/git2/refs.h | 2 | ||||
| -rw-r--r-- | include/git2/revwalk.h | 6 | ||||
| -rw-r--r-- | include/git2/signature.h | 2 | ||||
| -rw-r--r-- | include/git2/tag.h | 14 |
8 files changed, 31 insertions, 27 deletions
diff --git a/include/git2/commit.h b/include/git2/commit.h index cf14cd937..356b875cd 100644 --- a/include/git2/commit.h +++ b/include/git2/commit.h @@ -195,7 +195,6 @@ GIT_EXTERN(const git_oid *) git_commit_parent_oid(git_commit *commit, unsigned i /** * Create a new commit in the repository * - * * @param oid Pointer where to store the OID of the * newly created commit * @@ -221,7 +220,7 @@ GIT_EXTERN(const git_oid *) git_commit_parent_oid(git_commit *commit, unsigned i * * @param parent_count Number of parents for this commit * - * @param parents Array of pointers to parent OIDs for this commit. + * @param parent_oids[] Array of pointers to parent OIDs for this commit. * Note that no validation is performed on these OIDs. Use the _o * variants of this method to assure that are parents for the commit * are proper objects. diff --git a/include/git2/config.h b/include/git2/config.h index 4167bf8e5..502b0ae33 100644 --- a/include/git2/config.h +++ b/include/git2/config.h @@ -163,7 +163,7 @@ GIT_EXTERN(int) git_config_get_string(git_config *cfg, const char *name, const c * * @param cfg where to look for the variable * @param name the variable's name - * @param out pointer to the variable where the value should be stored + * @param value Integer value for the variable * @return GIT_SUCCESS on success; error code otherwise */ GIT_EXTERN(int) git_config_set_int(git_config *cfg, const char *name, int value); @@ -173,7 +173,7 @@ GIT_EXTERN(int) git_config_set_int(git_config *cfg, const char *name, int value) * * @param cfg where to look for the variable * @param name the variable's name - * @param out pointer to the variable where the value should be stored + * @param value Long integer value for the variable * @return GIT_SUCCESS on success; error code otherwise */ GIT_EXTERN(int) git_config_set_long(git_config *cfg, const char *name, long int value); diff --git a/include/git2/object.h b/include/git2/object.h index 83d37a263..07ba1a1c7 100644 --- a/include/git2/object.h +++ b/include/git2/object.h @@ -82,12 +82,12 @@ GIT_EXTERN(int) git_object_lookup( * The special value 'GIT_OBJ_ANY' may be passed to let * the method guess the object's type. * - * @param object pointer to the looked-up object + * @param object_out pointer where to store the looked-up object * @param repo the repository to look up the object * @param id a short identifier for the object * @param len the length of the short identifier * @param type the type of the object - * @return a reference to the object + * @return 0 on success; error code otherwise */ GIT_EXTERN(int) git_object_lookup_prefix( git_object **object_out, diff --git a/include/git2/odb.h b/include/git2/odb.h index 42961463c..06b9aa5f1 100644 --- a/include/git2/odb.h +++ b/include/git2/odb.h @@ -74,10 +74,14 @@ GIT_EXTERN(int) git_odb_open(git_odb **out, const char *objects_dir); /** * Add a custom backend to an existing Object DB * + * The backends are checked in relative ordering, based on the + * value of the `priority` parameter. + * * Read <odb_backends.h> for more information. * * @param odb database to add the backend to - * @paramm backend pointer to a git_odb_backend instance + * @param backend pointer to a git_odb_backend instance + * @param priority Value for ordering the backends queue * @return 0 on sucess; error code otherwise */ GIT_EXTERN(int) git_odb_add_backend(git_odb *odb, git_odb_backend *backend, int priority); @@ -87,14 +91,18 @@ GIT_EXTERN(int) git_odb_add_backend(git_odb *odb, git_odb_backend *backend, int * backend will work as an alternate. * * Alternate backends are always checked for objects *after* - * all the main backends have been exhausted. + * all the main backends have been exhausted. + * + * The backends are checked in relative ordering, based on the + * value of the `priority` parameter. * * Writing is disabled on alternate backends. * * Read <odb_backends.h> for more information. * * @param odb database to add the backend to - * @paramm backend pointer to a git_odb_backend instance + * @param backend pointer to a git_odb_backend instance + * @param priority Value for ordering the backends queue * @return 0 on sucess; error code otherwise */ GIT_EXTERN(int) git_odb_add_alternate(git_odb *odb, git_odb_backend *backend, int priority); @@ -143,16 +151,13 @@ GIT_EXTERN(int) git_odb_read(git_odb_object **out, git_odb *db, const git_oid *i * internally cached, so it should be closed * by the user once it's no longer in use. * - * @param out_oid the oid of the unique object matching - * the short id * @param out pointer where to store the read object * @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 - * - GIT_SUCCESS 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 GIT_SUCCESS 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, unsigned int len); diff --git a/include/git2/refs.h b/include/git2/refs.h index 35c72ac14..2c3aac7b0 100644 --- a/include/git2/refs.h +++ b/include/git2/refs.h @@ -213,7 +213,7 @@ GIT_EXTERN(int) git_reference_set_target(git_reference *ref, const char *target) * memory and on disk. * * @param ref The reference - * @param target The new target OID for the reference + * @param id The new target OID for the reference * @return 0 on success; error code otherwise */ GIT_EXTERN(int) git_reference_set_oid(git_reference *ref, const git_oid *id); diff --git a/include/git2/revwalk.h b/include/git2/revwalk.h index f3e0152d4..b37a16c83 100644 --- a/include/git2/revwalk.h +++ b/include/git2/revwalk.h @@ -113,7 +113,7 @@ GIT_EXTERN(void) git_revwalk_reset(git_revwalk *walker); * must be pushed the repository before a walk can * be started. * - * @param walker the walker being used for the traversal. + * @param walk the walker being used for the traversal. * @param oid the oid of the commit to start from. * @return 0 on success; error code otherwise */ @@ -129,8 +129,8 @@ GIT_EXTERN(int) git_revwalk_push(git_revwalk *walk, const git_oid *oid); * The resolved commit and all its parents will be hidden from the * output on the revision walk. * - * @param walker the walker being used for the traversal. - * @param commit the commit that will be ignored during the traversal + * @param walk the walker being used for the traversal. + * @param oid the oid of commit that will be ignored during the traversal * @return 0 on success; error code otherwise */ GIT_EXTERN(int) git_revwalk_hide(git_revwalk *walk, const git_oid *oid); diff --git a/include/git2/signature.h b/include/git2/signature.h index 44d1f285e..4b5601783 100644 --- a/include/git2/signature.h +++ b/include/git2/signature.h @@ -42,7 +42,7 @@ GIT_BEGIN_DECL * manually or using git_signature_free * * @param name name of the person - * @param mail email of the person + * @param email email of the person * @param time time when the action happened * @param offset timezone offset in minutes for the time * @return the new sig, NULL on out of memory diff --git a/include/git2/tag.h b/include/git2/tag.h index 49836a1f5..b92f79d22 100644 --- a/include/git2/tag.h +++ b/include/git2/tag.h @@ -105,7 +105,7 @@ GIT_EXTERN(const git_oid *) git_tag_id(git_tag *tag); * @param tag a previously loaded tag. * @return 0 on success; error code otherwise */ -GIT_EXTERN(int) git_tag_target(git_object **target, git_tag *t); +GIT_EXTERN(int) git_tag_target(git_object **target, git_tag *tag); /** * Get the OID of the tagged object of a tag @@ -113,7 +113,7 @@ GIT_EXTERN(int) git_tag_target(git_object **target, git_tag *t); * @param tag a previously loaded tag. * @return pointer to the OID */ -GIT_EXTERN(const git_oid *) git_tag_target_oid(git_tag *t); +GIT_EXTERN(const git_oid *) git_tag_target_oid(git_tag *tag); /** * Get the type of a tag's tagged object @@ -121,7 +121,7 @@ GIT_EXTERN(const git_oid *) git_tag_target_oid(git_tag *t); * @param tag a previously loaded tag. * @return type of the tagged object */ -GIT_EXTERN(git_otype) git_tag_type(git_tag *t); +GIT_EXTERN(git_otype) git_tag_type(git_tag *tag); /** * Get the name of a tag @@ -129,7 +129,7 @@ GIT_EXTERN(git_otype) git_tag_type(git_tag *t); * @param tag a previously loaded tag. * @return name of the tag */ -GIT_EXTERN(const char *) git_tag_name(git_tag *t); +GIT_EXTERN(const char *) git_tag_name(git_tag *tag); /** * Get the tagger (author) of a tag @@ -137,7 +137,7 @@ GIT_EXTERN(const char *) git_tag_name(git_tag *t); * @param tag a previously loaded tag. * @return reference to the tag's author */ -GIT_EXTERN(const git_signature *) git_tag_tagger(git_tag *t); +GIT_EXTERN(const git_signature *) git_tag_tagger(git_tag *tag); /** * Get the message of a tag @@ -145,7 +145,7 @@ GIT_EXTERN(const git_signature *) git_tag_tagger(git_tag *t); * @param tag a previously loaded tag. * @return message of the tag */ -GIT_EXTERN(const char *) git_tag_message(git_tag *t); +GIT_EXTERN(const char *) git_tag_message(git_tag *tag); /** @@ -302,7 +302,7 @@ GIT_EXTERN(int) git_tag_delete( * should be free'd manually when no longer needed, using * `git_strarray_free`. * - * @param array Pointer to a git_strarray structure where + * @param tag_names Pointer to a git_strarray structure where * the tag names will be stored * @param repo Repository where to find the tags * @return 0 on success; error code otherwise |