diff options
| author | Ben Chatelain <benchatelain@gmail.com> | 2015-02-10 08:31:48 -0700 |
|---|---|---|
| committer | Ben Chatelain <benchatelain@gmail.com> | 2015-02-10 08:31:48 -0700 |
| commit | ec7e1c93ce1c177026073abd16d6a8d2b548d3bd (patch) | |
| tree | dbfd9e26f2842133baf5a61fd986b5922f408a83 /include/git2/describe.h | |
| parent | b703049c6189fec223896999b9cf5d78efcb08d7 (diff) | |
| download | libgit2-ec7e1c93ce1c177026073abd16d6a8d2b548d3bd.tar.gz | |
Fix doc comment formatting
Diffstat (limited to 'include/git2/describe.h')
| -rw-r--r-- | include/git2/describe.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/include/git2/describe.h b/include/git2/describe.h index 66b88c4fa..d01a3f74c 100644 --- a/include/git2/describe.h +++ b/include/git2/describe.h @@ -129,7 +129,7 @@ GIT_EXTERN(int) git_describe_commit( * worktree. After peforming describe on HEAD, a status is run and the * description is considered to be dirty if there are. * - * @param result pointer to store the result. You must free this once + * @param out pointer to store the result. You must free this once * you're done with it. * @param repo the repository in which to perform the describe * @param opts the lookup options @@ -142,9 +142,10 @@ GIT_EXTERN(int) git_describe_workdir( /** * Print the describe result to a buffer * + * @param out The buffer to store the result * @param result the result from `git_describe_commit()` or * `git_describe_workdir()`. - * @param opt the formatting options + * @param opts the formatting options */ GIT_EXTERN(int) git_describe_format( git_buf *out, |