strbuf.h: reorganize api function grouping headers
commit14e2177a40ca5861f0518cb6bbe0a6856ffa7552
authorJeff King <peff@peff.net>
Fri, 16 Jan 2015 09:05:28 +0000 (16 04:05 -0500)
committerJunio C Hamano <gitster@pobox.com>
Fri, 16 Jan 2015 22:40:47 +0000 (16 14:40 -0800)
treefb862eb27eadce73ac40d208443e6eae52796313
parent088c9a86ff5332ee15415be3408ccf34687bc2d2
strbuf.h: reorganize api function grouping headers

The original API doc had something like:

    Functions
    ---------

    * Life cycle

      ... some life-cycle functions ...

    * Related to the contents of the buffer

      ... functions related to contents ....

    etc

This grouping can be hard to read in the comment sources,
given the "*" in the comment lines, and the amount of text
between each section.

Instead, let's make a flat list of groupings, and underline
each as a section header. That makes them stand out, and
eliminates the weird half-phrase of "Related to...". Like:

    Functions related to the contents of the buffer
    -----------------------------------------------

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
strbuf.h