Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Resolve documentation warnings #3332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 1, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,7 @@ ELSE ()
SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fPIC")
ENDIF ()

ADD_C_FLAG_IF_SUPPORTED(-Wdocumentation)
ADD_C_FLAG_IF_SUPPORTED(-Wno-missing-field-initializers)
ADD_C_FLAG_IF_SUPPORTED(-Wstrict-aliasing=2)
ADD_C_FLAG_IF_SUPPORTED(-Wstrict-prototypes)
Expand Down
2 changes: 1 addition & 1 deletion include/git2/repository.h
Original file line number Diff line number Diff line change
Expand Up @@ -745,7 +745,7 @@ GIT_EXTERN(int) git_repository_ident(const char **name, const char **email, cons
*
* @param repo the repository to configure
* @param name the name to use for the reflog entries
* @param name the email to use for the reflog entries
* @param email the email to use for the reflog entries
*/
GIT_EXTERN(int) git_repository_set_ident(git_repository *repo, const char *name, const char *email);

Expand Down
2 changes: 1 addition & 1 deletion include/git2/sys/config.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down
8 changes: 4 additions & 4 deletions include/git2/sys/diff.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -58,16 +58,16 @@ 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 *` */


/**
* Performance data from diffing
*/
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
Expand Down
2 changes: 1 addition & 1 deletion include/git2/sys/odb_backend.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down
2 changes: 1 addition & 1 deletion include/git2/sys/refdb_backend.h
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,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.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/path.h
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ extern int git_path_cmp(
* @param callback Function to invoke on each path. Passed the `payload`
* and the buffer containing the current path. The path should not
* be modified in any way. Return non-zero to stop iteration.
* @param state Passed to fn as the first ath.
* @param payload Passed to fn as the first ath.
*/
extern int git_path_walk_up(
git_buf *pathbuf,
Expand Down
4 changes: 3 additions & 1 deletion src/push.h
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ int git_push_add_refspec(git_push *push, const char *refspec);
* Update remote tips after a push
*
* @param push The push object
* @param signature The identity to use when updating reflogs
* @param callbacks the callbacks to use for this connection
*
* @return 0 or an error code
*/
Expand All @@ -100,6 +100,7 @@ int git_push_update_tips(git_push *push, const git_remote_callbacks *callbacks);
* order to find out which updates were accepted or rejected.
*
* @param push The push object
* @param callbacks the callbacks to use for this connection
*
* @return 0 or an error code
*/
Expand All @@ -117,6 +118,7 @@ int git_push_finish(git_push *push, const git_remote_callbacks *callbacks);
*
* @param push The push object
* @param cb The callback to call on each object
* @param data The payload passed to the callback
*
* @return 0 on success, non-zero callback return value, or error code
*/
Expand Down