summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosh Stockin <josh@joshstock.in>2021-01-04 10:56:01 -0600
committerJosh Stockin <josh@joshstock.in>2021-01-04 10:56:01 -0600
commit556e07473b80c8d4e763bda23ecf522136c7d06c (patch)
tree3b8b92fdca657e70e0710a9826778e19110b600f
parent0af0f7fdcf6e2fdc1139fef325ad01b77f3e86a3 (diff)
downloadlibgit2-556e07473b80c8d4e763bda23ecf522136c7d06c.tar.gz
Move doc comment about `GIT_BLOB_FILTER_OPTIONS_VERSION`
Removes doc comment on `git_blob_filter_options.version`, moves information to `git_blob_filter_options` doc comment to remain consistent with other options structures' documentation. `git_blob_filter_options_init` still needed; should be added in another commit/PR (it's out of the scope of this PR, #5759), update this documentation again.
-rw-r--r--include/git2/blob.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/include/git2/blob.h b/include/git2/blob.h
index 866b8bdd7..29588ecf0 100644
--- a/include/git2/blob.h
+++ b/include/git2/blob.h
@@ -118,9 +118,11 @@ typedef enum {
/**
* The options used when applying filter options to a file.
+ *
+ * Initialize with `GIT_BLOB_FILTER_OPTIONS_VERSION`.
+ *
*/
typedef struct {
- /** The struct version; set to `GIT_BLOB_FILTER_OPTIONS_VERSION`. */
int version;
/** Flags to control the filtering process, see `git_blob_filter_flag_t` above */