@@ -52,29 +52,32 @@ typedef enum {
5252 * `GIT_BLAME_OPTIONS_INIT` macro:
5353 * git_blame_options opts = GIT_BLAME_OPTIONS_INIT;
5454 *
55- * - `flags` is a combination of the `git_blame_flag_t` values above.
56- * - `min_match_characters` is the lower bound on the number of alphanumeric
57- * characters that must be detected as moving/copying within a file for it to
58- * associate those lines with the parent commit. The default value is 20.
59- * This value only takes effect if any of the `GIT_BLAME_TRACK_COPIES_*`
60- * flags are specified.
61- * - `newest_commit` is the id of the newest commit to consider. The default
62- * is HEAD.
63- * - `oldest_commit` is the id of the oldest commit to consider. The default
64- * is the first commit encountered with a NULL parent.
65- * - `min_line` is the first line in the file to blame. The default is 1 (line
66- * numbers start with 1).
67- * - `max_line` is the last line in the file to blame. The default is the last
68- * line of the file.
6955 */
7056typedef struct git_blame_options {
7157 unsigned int version ;
7258
59+ /** A combination of `git_blame_flag_t` */
7360 uint32_t flags ;
61+ /** The lower bound on the number of alphanumeric
62+ * characters that must be detected as moving/copying within a file for it to
63+ * associate those lines with the parent commit. The default value is 20.
64+ * This value only takes effect if any of the `GIT_BLAME_TRACK_COPIES_*`
65+ * flags are specified.
66+ */
7467 uint16_t min_match_characters ;
68+ /** The id of the newest commit to consider. The default is HEAD. */
7569 git_oid newest_commit ;
70+ /** The id of the oldest commit to consider.
71+ * The default is the first commit encountered with a NULL parent.
72+ */
7673 git_oid oldest_commit ;
74+ /** The first line in the file to blame.
75+ * The default is 1 (line numbers start with 1).
76+ */
7777 size_t min_line ;
78+ /** The last line in the file to blame.
79+ * The default is the last line of the file.
80+ */
7881 size_t max_line ;
7982} git_blame_options ;
8083
0 commit comments