diff options
author | Carlos MartÃn Nieto <carlosmn@github.com> | 2016-12-20 19:14:20 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-12-20 19:14:20 +0000 |
commit | 75db289a041b1f1084768244e167b953ac7eeaa5 (patch) | |
tree | 0eee49452f274bbc30c2658e18c8ddad0dbe9769 | |
parent | 42864e5842045b656f470c03de9f2a10591d794f (diff) | |
parent | 8d400c096ad059c2704e2804e202f6f9e69e5d51 (diff) | |
download | libgit2-75db289a041b1f1084768244e167b953ac7eeaa5.tar.gz |
Merge pull request #3980 from tiennou/doc-fixesv0.25.0-rc2v0.25.0
Documentation fixes
-rw-r--r-- | include/git2/describe.h | 7 | ||||
-rw-r--r-- | include/git2/remote.h | 6 | ||||
-rw-r--r-- | include/git2/transaction.h | 9 |
3 files changed, 17 insertions, 5 deletions
diff --git a/include/git2/describe.h b/include/git2/describe.h index 3044d9165..971eb350c 100644 --- a/include/git2/describe.h +++ b/include/git2/describe.h @@ -44,8 +44,8 @@ typedef enum { typedef struct git_describe_options { unsigned int version; - unsigned int max_candidates_tags; /** default: 10 */ - unsigned int describe_strategy; /** default: GIT_DESCRIBE_DEFAULT */ + unsigned int max_candidates_tags; /**< default: 10 */ + unsigned int describe_strategy; /**< default: GIT_DESCRIBE_DEFAULT */ const char *pattern; /** * When calculating the distance from the matching tag or @@ -105,6 +105,9 @@ typedef struct { GIT_EXTERN(int) git_describe_init_format_options(git_describe_format_options *opts, unsigned int version); +/** + * A struct that stores the result of a describe operation. + */ typedef struct git_describe_result git_describe_result; /** diff --git a/include/git2/remote.h b/include/git2/remote.h index 53c4aee46..691114172 100644 --- a/include/git2/remote.h +++ b/include/git2/remote.h @@ -26,8 +26,6 @@ */ GIT_BEGIN_DECL -typedef int (*git_remote_rename_problem_cb)(const char *problematic_refspec, void *payload); - /** * Add a remote with the default fetch refspec to the repository's configuration. * @@ -360,6 +358,8 @@ typedef struct { } git_push_update; /** + * Callback used to inform of upcoming updates. + * * @param updates an array containing the updates which will be sent * as commands to the destination. * @param len number of elements in `updates` @@ -403,7 +403,7 @@ struct git_remote_callbacks { * connection to proceed. Returns 1 to allow the connection, 0 * to disallow it or a negative value to indicate an error. */ - git_transport_certificate_check_cb certificate_check; + git_transport_certificate_check_cb certificate_check; /** * During the download of new data, this will be regularly diff --git a/include/git2/transaction.h b/include/git2/transaction.h index 64abb0c69..00ca13993 100644 --- a/include/git2/transaction.h +++ b/include/git2/transaction.h @@ -8,6 +8,14 @@ #define INCLUDE_git_transaction_h__ #include "common.h" + +/** + * @file git2/transaction.h + * @brief Git transactional reference routines + * @defgroup git_transaction Git transactional reference routines + * @ingroup Git + * @{ + */ GIT_BEGIN_DECL /** @@ -107,5 +115,6 @@ GIT_EXTERN(int) git_transaction_commit(git_transaction *tx); */ GIT_EXTERN(void) git_transaction_free(git_transaction *tx); +/** @} */ GIT_END_DECL #endif |