diff --git a/include/git2/apply.h b/include/git2/apply.h index 73fa65a2a..ed72483e6 100644 --- a/include/git2/apply.h +++ b/include/git2/apply.h @@ -91,6 +91,10 @@ typedef enum { * * @see git_apply_to_tree * @see git_apply + * + * @options[version] GIT_APPLY_OPTIONS_VERSION + * @options[init_macro] GIT_APPLY_OPTIONS_INIT + * @options[init_function] git_apply_options_init */ typedef struct { unsigned int version; /**< The version */ diff --git a/include/git2/attr.h b/include/git2/attr.h index e5216fef9..7b33c91fa 100644 --- a/include/git2/attr.h +++ b/include/git2/attr.h @@ -150,6 +150,10 @@ GIT_EXTERN(git_attr_value_t) git_attr_value(const char *attr); /** * An options structure for querying attributes. +* +* @options[version] GIT_ATTR_OPTIONS_VERSION +* @options[init_macro] GIT_ATTR_OPTIONS_INIT +* @options[init_function] git_attr_options_init */ typedef struct { unsigned int version; diff --git a/include/git2/blame.h b/include/git2/blame.h index 51dbac843..850359835 100644 --- a/include/git2/blame.h +++ b/include/git2/blame.h @@ -88,6 +88,9 @@ typedef enum { * Initialize with `GIT_BLAME_OPTIONS_INIT`. Alternatively, you can * use `git_blame_options_init`. * + * @options[version] GIT_BLAME_OPTIONS_VERSION + * @options[init_macro] GIT_BLAME_OPTIONS_INIT + * @options[init_function] git_blame_options_init */ typedef struct git_blame_options { unsigned int version; diff --git a/include/git2/cherrypick.h b/include/git2/cherrypick.h index bf33f6312..f430da18e 100644 --- a/include/git2/cherrypick.h +++ b/include/git2/cherrypick.h @@ -25,6 +25,10 @@ GIT_BEGIN_DECL /** * Cherry-pick options + * + * @options[version] GIT_CHERRYPICK_OPTIONS_VERSION + * @options[init_macro] GIT_CHERRYPICK_OPTIONS_INIT + * @options[init_function] git_cherrypick_options_init */ typedef struct { unsigned int version; diff --git a/include/git2/commit.h b/include/git2/commit.h index 64b8ba461..add30be56 100644 --- a/include/git2/commit.h +++ b/include/git2/commit.h @@ -364,6 +364,13 @@ typedef int GIT_CALLBACK(git_commit_signature_cb)( const char *commit_content, void *payload); +/** + * Commit creation options for the simple commit creation options. + * + * @options[version] GIT_COMMIT_CREATE_OPTIONS_VERSION + * @options[init_macro] GIT_COMMIT_CREATE_OPTIONS_INIT + * @options[init_function] git_commit_create_options_init + */ typedef struct { unsigned int version; @@ -423,6 +430,13 @@ GIT_EXTERN(int) git_commit_create_from_stage( const char *message, const git_commit_create_options *opts); +/** + * Commit creation options for the extended commit creation options. + * + * @options[version] GIT_COMMIT_CREATE_EXT_OPTIONS_VERSION + * @options[init_macro] GIT_COMMIT_CREATE_EXT_OPTIONS_INIT + * @options[init_function] git_commit_create_ext_options_init + */ typedef struct { unsigned int version; diff --git a/include/git2/deprecated.h b/include/git2/deprecated.h index b070dc5d7..634532b19 100644 --- a/include/git2/deprecated.h +++ b/include/git2/deprecated.h @@ -334,6 +334,10 @@ typedef enum { * Options for controlling the formatting of the generated e-mail. * * @deprecated use `git_email_create_options` + * + * @options[version] GIT_DIFF_FORMAT_EMAIL_OPTIONS_VERSION + * @options[init_macro] GIT_DIFF_FORMAT_EMAIL_OPTIONS_INIT + * @options[init_function] git_diff_format_email_options_init */ typedef struct { unsigned int version; diff --git a/include/git2/describe.h b/include/git2/describe.h index 2eb7b020b..43144a928 100644 --- a/include/git2/describe.h +++ b/include/git2/describe.h @@ -43,6 +43,9 @@ typedef enum { * Initialize with `GIT_DESCRIBE_OPTIONS_INIT`. Alternatively, you can * use `git_describe_options_init`. * + * @options[version] GIT_DESCRIBE_OPTIONS_VERSION + * @options[init_macro] GIT_DESCRIBE_OPTIONS_INIT + * @options[init_function] git_describe_options_init */ typedef struct git_describe_options { unsigned int version; @@ -96,6 +99,9 @@ GIT_EXTERN(int) git_describe_options_init(git_describe_options *opts, unsigned i * Initialize with `GIT_DESCRIBE_FORMAT_OPTIONS_INIT`. Alternatively, you can * use `git_describe_format_options_init`. * + * @options[version] GIT_DESCRIBE_FORMAT_OPTIONS_VERSION + * @options[init_macro] GIT_DESCRIBE_FORMAT_OPTIONS_INIT + * @options[init_function] git_describe_format_options_init */ typedef struct { unsigned int version; diff --git a/include/git2/email.h b/include/git2/email.h index ad37e4249..d717fabbe 100644 --- a/include/git2/email.h +++ b/include/git2/email.h @@ -40,6 +40,10 @@ typedef enum { /** * Options for controlling the formatting of the generated e-mail. + * + * @options[version] GIT_EMAIL_CREATE_OPTIONS_VERSION + * @options[init_macro] GIT_EMAIL_CREATE_OPTIONS_INIT + * @options[init_function] git_email_create_options_init */ typedef struct { unsigned int version; diff --git a/include/git2/filter.h b/include/git2/filter.h index c056fc9ca..43c0e60c0 100644 --- a/include/git2/filter.h +++ b/include/git2/filter.h @@ -65,6 +65,10 @@ typedef enum { /** * Filtering options + * + * @options[version] GIT_FILTER_OPTIONS_VERSION + * @options[init_macro] GIT_FILTER_OPTIONS_INIT + * @options[init_function] git_filter_options_init */ typedef struct { unsigned int version; diff --git a/include/git2/indexer.h b/include/git2/indexer.h index 2e29bc8b2..04bd9b492 100644 --- a/include/git2/indexer.h +++ b/include/git2/indexer.h @@ -69,6 +69,10 @@ typedef int GIT_CALLBACK(git_indexer_progress_cb)(const git_indexer_progress *st /** * Options for indexer configuration + * + * @options[version] GIT_INDEXER_OPTIONS_VERSION + * @options[init_macro] GIT_INDEXER_OPTIONS_INIT + * @options[init_function] git_indexer_options_init */ typedef struct git_indexer_options { unsigned int version; diff --git a/include/git2/merge.h b/include/git2/merge.h index 91d9cf919..52b5a2e5a 100644 --- a/include/git2/merge.h +++ b/include/git2/merge.h @@ -191,6 +191,10 @@ typedef enum { /** * Options for merging a file + * + * @options[version] GIT_MERGE_FILE_OPTIONS_VERSION + * @options[init_macro] GIT_MERGE_FILE_OPTIONS_INIT + * @options[init_function] git_merge_file_options_init */ typedef struct { unsigned int version; @@ -270,6 +274,10 @@ typedef struct { /** * Merging options + * + * @options[version] GIT_MERGE_OPTIONS_VERSION + * @options[init_macro] GIT_MERGE_OPTIONS_INIT + * @options[init_function] git_merge_options_init */ typedef struct { unsigned int version; diff --git a/include/git2/object.h b/include/git2/object.h index 5bac2ffe2..4fb3d6e4a 100644 --- a/include/git2/object.h +++ b/include/git2/object.h @@ -231,6 +231,10 @@ GIT_EXTERN(int) git_object_dup(git_object **dest, git_object *source); * * Initialize with `GIT_OBJECT_ID_OPTIONS_INIT`. Alternatively, you can * use `git_object_id_options_init`. + * + * @options[version] GIT_OBJECT_ID_OPTIONS_VERSION + * @options[init_macro] GIT_OBJECT_ID_OPTIONS_INIT + * @options[init_function] git_object_id_options_init */ typedef struct { unsigned int version; /**< version for the struct */ diff --git a/include/git2/odb.h b/include/git2/odb.h index a725ac6bb..f1bd8d2a8 100644 --- a/include/git2/odb.h +++ b/include/git2/odb.h @@ -42,7 +42,13 @@ typedef enum { */ typedef int GIT_CALLBACK(git_odb_foreach_cb)(const git_oid *id, void *payload); -/** Options for configuring a loose object backend. */ +/** + * Options for configuring a loose object backend. + * + * @options[version] GIT_ODB_OPTIONS_VERSION + * @options[init_macro] GIT_ODB_OPTIONS_INIT + * @options[init_function] git_odb_options_init + */ typedef struct { unsigned int version; /**< version for the struct */ diff --git a/include/git2/odb_backend.h b/include/git2/odb_backend.h index 88ca29fb9..8863c0274 100644 --- a/include/git2/odb_backend.h +++ b/include/git2/odb_backend.h @@ -20,7 +20,13 @@ */ GIT_BEGIN_DECL -/** Options for configuring a packfile object backend. */ +/** + * Options for configuring a packfile object backend. + * + * @options[version] GIT_ODB_BACKEND_PACK_OPTIONS_VERSION + * @options[init_macro] GIT_ODB_BACKEND_PACK_OPTIONS_INIT + * @options[init_function] git_odb_backend_pack_options_init + */ typedef struct { unsigned int version; /**< version for the struct */ @@ -45,7 +51,13 @@ typedef enum { GIT_ODB_BACKEND_LOOSE_FSYNC = (1 << 0) } git_odb_backend_loose_flag_t; -/** Options for configuring a loose object backend. */ +/** + * Options for configuring a loose object backend. + * + * @options[version] GIT_ODB_BACKEND_LOOSE_OPTIONS_VERSION + * @options[init_macro] GIT_ODB_BACKEND_LOOSE_OPTIONS_INIT + * @options[init_function] git_odb_backend_loose_options_init + */ typedef struct { unsigned int version; /**< version for the struct */ diff --git a/include/git2/proxy.h b/include/git2/proxy.h index fc8ffaaa8..28d61e3c0 100644 --- a/include/git2/proxy.h +++ b/include/git2/proxy.h @@ -46,6 +46,10 @@ typedef enum { * * Note that not all types may be supported, depending on the platform * and compilation options. + * + * @options[version] GIT_PROXY_OPTIONS_VERSION + * @options[init_macro] GIT_PROXY_OPTIONS_INIT + * @options[init_function] git_proxy_options_init */ typedef struct { unsigned int version; diff --git a/include/git2/rebase.h b/include/git2/rebase.h index 4690bbd9a..5145e2b99 100644 --- a/include/git2/rebase.h +++ b/include/git2/rebase.h @@ -25,9 +25,11 @@ GIT_BEGIN_DECL /** - * Rebase options + * Rebase options. Use to tell the rebase machinery how to operate. * - * Use to tell the rebase machinery how to operate. + * @options[version] GIT_REBASE_OPTIONS_VERSION + * @options[init_macro] GIT_REBASE_OPTIONS_INIT + * @options[init_function] git_rebase_options_init */ typedef struct { unsigned int version; diff --git a/include/git2/remote.h b/include/git2/remote.h index 9da3431a0..af877b4c7 100644 --- a/include/git2/remote.h +++ b/include/git2/remote.h @@ -93,6 +93,9 @@ typedef enum { * Initialize with `GIT_REMOTE_CREATE_OPTIONS_INIT`. Alternatively, you can * use `git_remote_create_options_init`. * + * @options[version] GIT_REMOTE_CREATE_OPTIONS_VERSION + * @options[init_macro] GIT_REMOTE_CREATE_OPTIONS_INIT + * @options[init_function] git_remote_create_options_init */ typedef struct git_remote_create_options { unsigned int version; @@ -786,10 +789,13 @@ typedef enum { /** * Fetch options structure. * - * Zero out for defaults. Initialize with `GIT_FETCH_OPTIONS_INIT` macro to - * correctly set the `version` field. E.g. + * Initialize with `GIT_FETCH_OPTIONS_INIT` macro to correctly set + * the `version` field. e.g. + * git_fetch_options opts = GIT_FETCH_OPTIONS_INIT; * - * git_fetch_options opts = GIT_FETCH_OPTIONS_INIT; + * @options[version] GIT_FETCH_OPTIONS_VERSION + * @options[init_macro] GIT_FETCH_OPTIONS_INIT + * @options[init_function] git_fetch_options_init */ typedef struct { int version; @@ -874,6 +880,10 @@ GIT_EXTERN(int) git_fetch_options_init( /** * Controls the behavior of a git_push object. + * + * @options[version] GIT_PUSH_OPTIONS_VERSION + * @options[init_macro] GIT_PUSH_OPTIONS_INIT + * @options[init_function] git_push_options_init */ typedef struct { unsigned int version; @@ -942,6 +952,9 @@ GIT_EXTERN(int) git_push_options_init( * Initialize with `GIT_REMOTE_CREATE_OPTIONS_INIT`. Alternatively, you can * use `git_remote_create_options_init`. * + * @options[version] GIT_REMOTE_CONNECT_OPTIONS_VERSION + * @options[init_macro] GIT_REMOTE_CONNECT_OPTIONS_INIT + * @options[init_function] git_remote_connect_options_init */ typedef struct { unsigned int version; diff --git a/include/git2/repository.h b/include/git2/repository.h index df8dc2b43..d59b89571 100644 --- a/include/git2/repository.h +++ b/include/git2/repository.h @@ -320,6 +320,10 @@ typedef enum { * * This contains extra options for `git_repository_init_ext` that enable * additional initialization features. + * + * @options[version] GIT_REPOSITORY_INIT_OPTIONS_VERSION + * @options[init_macro] GIT_REPOSITORY_INIT_OPTIONS_INIT + * @options[init_function] git_repository_init_options_init */ typedef struct { unsigned int version; diff --git a/include/git2/revert.h b/include/git2/revert.h index 5f590663d..21390ffda 100644 --- a/include/git2/revert.h +++ b/include/git2/revert.h @@ -22,6 +22,10 @@ GIT_BEGIN_DECL /** * Options for revert + * + * @options[version] GIT_REVERT_OPTIONS_VERSION + * @options[init_macro] GIT_REVERT_OPTIONS_INIT + * @options[init_function] git_revert_options_init */ typedef struct { unsigned int version; diff --git a/include/git2/stash.h b/include/git2/stash.h index ad28c3263..84c42030d 100644 --- a/include/git2/stash.h +++ b/include/git2/stash.h @@ -82,6 +82,9 @@ GIT_EXTERN(int) git_stash_save( * Initialize with `GIT_STASH_SAVE_OPTIONS_INIT`. Alternatively, you can * use `git_stash_save_options_init`. * + * @options[version] GIT_STASH_SAVE_OPTIONS_VERSION + * @options[init_macro] GIT_STASH_SAVE_OPTIONS_INIT + * @options[init_function] git_stash_save_options_init */ typedef struct git_stash_save_options { unsigned int version; @@ -188,6 +191,9 @@ typedef int GIT_CALLBACK(git_stash_apply_progress_cb)( * Initialize with `GIT_STASH_APPLY_OPTIONS_INIT`. Alternatively, you can * use `git_stash_apply_options_init`. * + * @options[version] GIT_STASH_APPLY_OPTIONS_VERSION + * @options[init_macro] GIT_STASH_APPLY_OPTIONS_INIT + * @options[init_function] git_stash_apply_options_init */ typedef struct git_stash_apply_options { unsigned int version; diff --git a/include/git2/status.h b/include/git2/status.h index b863a4dd6..904a0fc28 100644 --- a/include/git2/status.h +++ b/include/git2/status.h @@ -218,6 +218,9 @@ typedef enum { * Initialize with `GIT_STATUS_OPTIONS_INIT`. Alternatively, you can * use `git_status_options_init`. * + * @options[version] GIT_STATUS_OPTIONS_VERSION + * @options[init_macro] GIT_STATUS_OPTIONS_INIT + * @options[init_function] git_status_options_init */ typedef struct { /** diff --git a/include/git2/submodule.h b/include/git2/submodule.h index 58daa6f88..534dfc6c6 100644 --- a/include/git2/submodule.h +++ b/include/git2/submodule.h @@ -131,6 +131,9 @@ typedef int GIT_CALLBACK(git_submodule_cb)( * Initialize with `GIT_SUBMODULE_UPDATE_OPTIONS_INIT`. Alternatively, you can * use `git_submodule_update_options_init`. * + * @options[version] GIT_SUBMODULE_UPDATE_OPTIONS_VERSION + * @options[init_macro] GIT_SUBMODULE_UPDATE_OPTIONS_INIT + * @options[init_function] git_submodule_update_options_init */ typedef struct git_submodule_update_options { unsigned int version; diff --git a/include/git2/sys/commit_graph.h b/include/git2/sys/commit_graph.h index 96cd45aa2..28648e617 100644 --- a/include/git2/sys/commit_graph.h +++ b/include/git2/sys/commit_graph.h @@ -24,6 +24,10 @@ GIT_BEGIN_DECL * * Initialize with `GIT_COMMIT_GRAPH_OPEN_OPTIONS_INIT`. Alternatively, * you can use `git_commit_graph_open_options_init`. + * + * @options[version] GIT_COMMIT_GRAPH_OPEN_OPTIONS_VERSION + * @options[init_macro] GIT_COMMIT_GRAPH_OPEN_OPTIONS_INIT + * @options[init_function] git_commit_graph_open_options_init */ typedef struct { unsigned int version; @@ -103,6 +107,10 @@ typedef enum { * * Initialize with `GIT_COMMIT_GRAPH_WRITER_OPTIONS_INIT`. Alternatively, * you can use `git_commit_graph_writer_options_init`. + * + * @options[version] GIT_COMMIT_GRAPH_WRITER_OPTIONS_VERSION + * @options[init_macro] GIT_COMMIT_GRAPH_WRITER_OPTIONS_INIT + * @options[init_function] git_commit_graph_writer_options_init */ typedef struct { unsigned int version; diff --git a/include/git2/sys/config.h b/include/git2/sys/config.h index 5ddf68cb8..86db494e4 100644 --- a/include/git2/sys/config.h +++ b/include/git2/sys/config.h @@ -144,7 +144,12 @@ GIT_EXTERN(int) git_config_add_backend( const git_repository *repo, int force); -/** Options for in-memory configuration backends. */ +/** + * Options for in-memory configuration backends. + * @options[version] GIT_CONFIG_BACKEND_MEMORY_OPTIONS_VERSION + * @options[init_macro] GIT_CONFIG_BACKEND_MEMORY_OPTIONS_INIT + * @options[init_function] git_config_backend_memory_options_init + */ typedef struct { unsigned int version; diff --git a/include/git2/sys/midx.h b/include/git2/sys/midx.h index 069a76a32..b6dfb1fff 100644 --- a/include/git2/sys/midx.h +++ b/include/git2/sys/midx.h @@ -24,6 +24,10 @@ GIT_BEGIN_DECL * * Initialize with `GIT_MIDX_WRITER_OPTIONS_INIT`. Alternatively, * you can use `git_midx_writer_options_init`. + * + * @options[version] GIT_MIDX_WRITER_OPTIONS_VERSION + * @options[init_macro] GIT_MIDX_WRITER_OPTIONS_INIT + * @options[init_function] git_midx_writer_options_init */ typedef struct { unsigned int version; diff --git a/include/git2/worktree.h b/include/git2/worktree.h index 0a57e4077..f593a6517 100644 --- a/include/git2/worktree.h +++ b/include/git2/worktree.h @@ -87,6 +87,9 @@ GIT_EXTERN(int) git_worktree_validate(const git_worktree *wt); * Initialize with `GIT_WORKTREE_ADD_OPTIONS_INIT`. Alternatively, you can * use `git_worktree_add_options_init`. * + * @options[version] GIT_WORKTREE_ADD_OPTIONS_VERSION + * @options[init_macro] GIT_WORKTREE_ADD_OPTIONS_INIT + * @options[init_function] git_worktree_add_options_init */ typedef struct git_worktree_add_options { unsigned int version; @@ -214,6 +217,9 @@ typedef enum { * Initialize with `GIT_WORKTREE_PRUNE_OPTIONS_INIT`. Alternatively, you can * use `git_worktree_prune_options_init`. * + * @options[version] GIT_WORKTREE_PRUNE_OPTIONS_VERSION + * @options[init_macro] GIT_WORKTREE_PRUNE_OPTIONS_INIT + * @options[init_function] git_worktree_prune_options_init */ typedef struct git_worktree_prune_options { unsigned int version;