| commit | 08342573792e9af79bf41b32c45ac471d25303bc | |
| author | Ævar Arnfjörð Bjarmason <avarab@gmail.com> | |
| Thu, 26 Aug 2021 14:05:47 +0000 (26 16:05 +0200) | ||
| committer | Junio C Hamano <gitster@pobox.com> | |
| Sat, 28 Aug 2021 01:07:27 +0000 (27 18:07 -0700) | ||
| tree | 2265252b85aae67666dec02966b8106aca92dedd | treesnapshot (tar.gz zip) |
| parent | c4203212e360b25a1c69467b5a8437d45a373cac | commitdiff |
bundle API: start writing API documentation
There are no other API docs in bundle.h, but this is at least a
start. We'll add a parameter to this function in a subsequent commit,
but let's start by documenting it.
The "/**" comment (as opposed to "/*") signifies the start of API
documentation. See [1] and bdfdaa4978d (strbuf.h: integrate
api-strbuf.txt documentation, 2015-01-16) and 6afbbdda333 (strbuf.h:
unify documentation comments beginnings, 2015-01-16) for a discussion
of that convention.
1. https://lore.kernel.org/git/874kbeecfu.fsf@evledraar.gmail.com/
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
There are no other API docs in bundle.h, but this is at least a
start. We'll add a parameter to this function in a subsequent commit,
but let's start by documenting it.
The "/**" comment (as opposed to "/*") signifies the start of API
documentation. See [1] and bdfdaa4978d (strbuf.h: integrate
api-strbuf.txt documentation, 2015-01-16) and 6afbbdda333 (strbuf.h:
unify documentation comments beginnings, 2015-01-16) for a discussion
of that convention.
1. https://lore.kernel.org/git/874kbeecfu.fsf@evledraar.gmail.com/
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| bundle.h | diffblobblamehistory |