diff options
| author | Etienne Samson <samson.etienne@gmail.com> | 2018-03-22 23:27:34 +0100 |
|---|---|---|
| committer | Etienne Samson <samson.etienne@gmail.com> | 2018-05-07 21:50:38 +0200 |
| commit | bf46d45846de1b4822e60ab8905f5c3b93794da8 (patch) | |
| tree | eba6d149fc86eac37c46f91576dca7f7c4e078b0 /include | |
| parent | 132f2ce039c238f7e0f5112dd19b25ab3d3c30e2 (diff) | |
| download | libgit2-bf46d45846de1b4822e60ab8905f5c3b93794da8.tar.gz | |
docs: move blame options struct field comments
Diffstat (limited to 'include')
| -rw-r--r-- | include/git2/blame.h | 31 |
1 files changed, 17 insertions, 14 deletions
diff --git a/include/git2/blame.h b/include/git2/blame.h index ec7a24a5d..cbc6ab6a8 100644 --- a/include/git2/blame.h +++ b/include/git2/blame.h @@ -52,29 +52,32 @@ typedef enum { * `GIT_BLAME_OPTIONS_INIT` macro: * git_blame_options opts = GIT_BLAME_OPTIONS_INIT; * - * - `flags` is a combination of the `git_blame_flag_t` values above. - * - `min_match_characters` is the lower bound on the number of alphanumeric - * characters that must be detected as moving/copying within a file for it to - * associate those lines with the parent commit. The default value is 20. - * This value only takes effect if any of the `GIT_BLAME_TRACK_COPIES_*` - * flags are specified. - * - `newest_commit` is the id of the newest commit to consider. The default - * is HEAD. - * - `oldest_commit` is the id of the oldest commit to consider. The default - * is the first commit encountered with a NULL parent. - * - `min_line` is the first line in the file to blame. The default is 1 (line - * numbers start with 1). - * - `max_line` is the last line in the file to blame. The default is the last - * line of the file. */ typedef struct git_blame_options { unsigned int version; + /** A combination of `git_blame_flag_t` */ uint32_t flags; + /** The lower bound on the number of alphanumeric + * characters that must be detected as moving/copying within a file for it to + * associate those lines with the parent commit. The default value is 20. + * This value only takes effect if any of the `GIT_BLAME_TRACK_COPIES_*` + * flags are specified. + */ uint16_t min_match_characters; + /** The id of the newest commit to consider. The default is HEAD. */ git_oid newest_commit; + /** The id of the oldest commit to consider. + * The default is the first commit encountered with a NULL parent. + */ git_oid oldest_commit; + /** The first line in the file to blame. + * The default is 1 (line numbers start with 1). + */ size_t min_line; + /** The last line in the file to blame. + * The default is the last line of the file. + */ size_t max_line; } git_blame_options; |
