diff options
| author | Andreas Linde <mail@andreaslinde.de> | 2013-06-24 15:33:41 +0200 |
|---|---|---|
| committer | Andreas Linde <mail@andreaslinde.de> | 2013-06-24 15:33:41 +0200 |
| commit | e1967164574816b8bf6740ea17d08eeb26c091d2 (patch) | |
| tree | b074641f5a6680946c5e861ac630b3a5c41a1ee0 /include/git2/tree.h | |
| parent | 9f1b2c5cb79526f274c0c72eed56f9da0efb0321 (diff) | |
| download | libgit2-e1967164574816b8bf6740ea17d08eeb26c091d2.tar.gz | |
Fixed most documentation header bugs
Fixed a few header @param and @return typos with the help of -Wdocumentation in Xcode.
The following warnings have not been fixed:
common.h:213 - Not sure how the documentation format is for '...'
notes.h:102 - Correct @param name but empty text
notes.h:111 - Correct @param name but empty text
pack.h:140 - @return missing text
pack.h:148 - @return missing text
Diffstat (limited to 'include/git2/tree.h')
| -rw-r--r-- | include/git2/tree.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/git2/tree.h b/include/git2/tree.h index d673f50c4..65d8cc16e 100644 --- a/include/git2/tree.h +++ b/include/git2/tree.h @@ -38,7 +38,7 @@ GIT_EXTERN(int) git_tree_lookup( * * @see git_object_lookup_prefix * - * @param tree pointer to the looked up tree + * @param out pointer to the looked up tree * @param repo the repo to use when locating the tree. * @param id identity of the tree to locate. * @param len the length of the short identifier @@ -136,7 +136,7 @@ GIT_EXTERN(const git_tree_entry *) git_tree_entry_byoid( * * @param out Pointer where to store the tree entry * @param root Previously loaded tree which is the root of the relative path - * @param subtree_path Path to the contained entry + * @param path Path to the contained entry * @return 0 on success; GIT_ENOTFOUND if the path does not exist */ GIT_EXTERN(int) git_tree_entry_bypath( @@ -212,7 +212,7 @@ GIT_EXTERN(int) git_tree_entry_cmp(const git_tree_entry *e1, const git_tree_entr * * You must call `git_object_free()` on the object when you are done with it. * - * @param object pointer to the converted object + * @param object_out pointer to the converted object * @param repo repository where to lookup the pointed object * @param entry a tree entry * @return 0 or an error code @@ -251,7 +251,7 @@ GIT_EXTERN(void) git_treebuilder_clear(git_treebuilder *bld); /** * Get the number of entries listed in a treebuilder * - * @param tree a previously loaded treebuilder. + * @param bld a previously loaded treebuilder. * @return the number of entries in the treebuilder */ GIT_EXTERN(unsigned int) git_treebuilder_entrycount(git_treebuilder *bld); |