Commit 6e0fa05b58c140a42ef25dc74041e30f25772b2c

Ramsay Jones 2010-06-01T19:34:48

Fix a doxygen warning In particular, doxygen issues the following warning: .../src/git/revwalk.h:86: Warning: The following parameters of \ gitrp_sorting(git_revpool *pool, unsigned int sort_mode) are \ not documented: parameter 'pool' Signed-off-by: Ramsay Jones <ramsay@ramsay1.demon.co.uk> Signed-off-by: Andreas Ericsson <ae@op5.se>

1
2
3
4
5
6
7
8
9
10
11
12
diff --git a/src/git/revwalk.h b/src/git/revwalk.h
index 027a51a..7aa92d4 100644
--- a/src/git/revwalk.h
+++ b/src/git/revwalk.h
@@ -86,6 +86,7 @@ GIT_EXTERN(git_commit *) gitrp_next(git_revpool *pool);
 /**
  * Change the sorting mode when iterating through the
  * revision pool's contents.
+ * @param pool the pool being used for the traversal.
  * @param sort_mode combination of GIT_RPSORT_XXX flags
  */
 GIT_EXTERN(void) gitrp_sorting(git_revpool *pool, unsigned int sort_mode);