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/submodule.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/submodule.h')
| -rw-r--r-- | include/git2/submodule.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/git2/submodule.h b/include/git2/submodule.h index 004665050..91b5300ae 100644 --- a/include/git2/submodule.h +++ b/include/git2/submodule.h @@ -481,7 +481,7 @@ GIT_EXTERN(int) git_submodule_sync(git_submodule *submodule); * function will return distinct `git_repository` objects. This will only * work if the submodule is checked out into the working directory. * - * @param subrepo Pointer to the submodule repo which was opened + * @param repo Pointer to the submodule repo which was opened * @param submodule Submodule to be opened * @return 0 on success, <0 if submodule repo could not be opened. */ @@ -531,7 +531,7 @@ GIT_EXTERN(int) git_submodule_status( * This can be useful if you want to know if the submodule is present in the * working directory at this point in time, etc. * - * @param status Combination of first four `GIT_SUBMODULE_STATUS` flags + * @param location_status Combination of first four `GIT_SUBMODULE_STATUS` flags * @param submodule Submodule for which to get status * @return 0 on success, <0 on error */ |