diff options
| author |  Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2021-08-26 16:05:47 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2021-08-27 18:07:27 -0700 |
| commit | 08342573792e9af79bf41b32c45ac471d25303bc (patch) | |
| tree | 2265252b85aae67666dec02966b8106aca92dedd /midx.h | |
| parent | The first batch post 2.33 (diff) | |
| download | tgif-08342573792e9af79bf41b32c45ac471d25303bc.tar.xz | |
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>
Diffstat (limited to 'midx.h')
0 files changed, 0 insertions, 0 deletions