Commit 556e07473b80c8d4e763bda23ecf522136c7d06c

Josh Stockin 2021-01-04T10:56:01

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.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
diff --git a/include/git2/blob.h b/include/git2/blob.h
index 866b8bd..29588ec 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 */