From: Stefan Beller <sbeller@google.com>
Date: Tue, 09 Dec 2014 20:32:15 GMT
Subject: Re: [PATCH] document string_list_clear
Message-ID: <CAGZ79kZa5sPxbzURtGScCrfbTaCX_cHiRj7uew6Xk+1Df7oTEQ@mail.gmail.com>
In-Reply-To: <20141209202738.GC12001@peff.net>

On Tue, Dec 9, 2014 at 12:27 PM, Jeff King <peff@peff.net> wrote:

>
> In which case can we simply start migrating api-strbuf.txt into
> in-header comments, without worrying about a parsing tool?
>
> -Peff

That would be my preference as well. Putting the API documentation
into the header files. Optionally if you're fancy you may enjoy the generated
API documentation. But I personally would rather look into the header for
the most up to date information.

As said above the Documentation/technical would only serve a purpose to
explain very high level concepts. So racy-git.txt or
pack-heuristics.txt will fit
in there very good.