summaryrefslogtreecommitdiff
path: root/include/git2/sys
diff options
context:
space:
mode:
authorCarlos Martín Nieto <cmn@dwim.me>2015-08-01 15:38:04 +0200
committerCarlos Martín Nieto <cmn@dwim.me>2015-08-01 15:38:04 +0200
commitc400bac4db12d8be95f1876d16231743b5696244 (patch)
tree00b19e6ac56a0d4e2d44fc9bdebbe4877aa50e08 /include/git2/sys
parent723babd7124ae420f9afea65e25231d206ac1a20 (diff)
parent6d8f3a5162f3160069a2cbafeb44e9ffd4ebe77c (diff)
downloadlibgit2-c400bac4db12d8be95f1876d16231743b5696244.tar.gz
Merge pull request #3332 from phatblat/ben/doc-warnings
Resolve documentation warnings
Diffstat (limited to 'include/git2/sys')
-rw-r--r--include/git2/sys/config.h2
-rw-r--r--include/git2/sys/diff.h8
-rw-r--r--include/git2/sys/odb_backend.h2
-rw-r--r--include/git2/sys/refdb_backend.h2
4 files changed, 7 insertions, 7 deletions
diff --git a/include/git2/sys/config.h b/include/git2/sys/config.h
index b5b7df15f..044e34417 100644
--- a/include/git2/sys/config.h
+++ b/include/git2/sys/config.h
@@ -76,7 +76,7 @@ struct git_config_backend {
* Initializes a `git_config_backend` with default values. Equivalent to
* creating an instance with GIT_CONFIG_BACKEND_INIT.
*
- * @param opts the `git_config_backend` struct to initialize.
+ * @param backend the `git_config_backend` struct to initialize.
* @param version Version of struct; pass `GIT_CONFIG_BACKEND_VERSION`
* @return Zero on success; -1 on failure.
*/
diff --git a/include/git2/sys/diff.h b/include/git2/sys/diff.h
index 034d5c478..aefd7b997 100644
--- a/include/git2/sys/diff.h
+++ b/include/git2/sys/diff.h
@@ -38,7 +38,7 @@ GIT_EXTERN(int) git_diff_print_callback__to_buf(
const git_diff_delta *delta,
const git_diff_hunk *hunk,
const git_diff_line *line,
- void *payload); /*< payload must be a `git_buf *` */
+ void *payload); /**< payload must be a `git_buf *` */
/**
* Diff print callback that writes to stdio FILE handle.
@@ -58,7 +58,7 @@ GIT_EXTERN(int) git_diff_print_callback__to_file_handle(
const git_diff_delta *delta,
const git_diff_hunk *hunk,
const git_diff_line *line,
- void *payload); /*< payload must be a `FILE *` */
+ void *payload); /**< payload must be a `FILE *` */
/**
@@ -66,8 +66,8 @@ GIT_EXTERN(int) git_diff_print_callback__to_file_handle(
*/
typedef struct {
unsigned int version;
- size_t stat_calls; /*< Number of stat() calls performed */
- size_t oid_calculations; /*< Number of ID calculations */
+ size_t stat_calls; /**< Number of stat() calls performed */
+ size_t oid_calculations; /**< Number of ID calculations */
} git_diff_perfdata;
#define GIT_DIFF_PERFDATA_VERSION 1
diff --git a/include/git2/sys/odb_backend.h b/include/git2/sys/odb_backend.h
index 0a51c6dba..fe102ff3c 100644
--- a/include/git2/sys/odb_backend.h
+++ b/include/git2/sys/odb_backend.h
@@ -93,7 +93,7 @@ struct git_odb_backend {
* Initializes a `git_odb_backend` with default values. Equivalent to
* creating an instance with GIT_ODB_BACKEND_INIT.
*
- * @param opts the `git_odb_backend` struct to initialize.
+ * @param backend the `git_odb_backend` struct to initialize.
* @param version Version the struct; pass `GIT_ODB_BACKEND_VERSION`
* @return Zero on success; -1 on failure.
*/
diff --git a/include/git2/sys/refdb_backend.h b/include/git2/sys/refdb_backend.h
index 9f2a99b7e..01fce8009 100644
--- a/include/git2/sys/refdb_backend.h
+++ b/include/git2/sys/refdb_backend.h
@@ -176,7 +176,7 @@ struct git_refdb_backend {
* Initializes a `git_refdb_backend` with default values. Equivalent to
* creating an instance with GIT_REFDB_BACKEND_INIT.
*
- * @param opts the `git_refdb_backend` struct to initialize
+ * @param backend the `git_refdb_backend` struct to initialize
* @param version Version of struct; pass `GIT_REFDB_BACKEND_VERSION`
* @return Zero on success; -1 on failure.
*/