Re: [PATCH 1/8] sha1-array: provide oid_array_filter
- From
Jeff King <peff@peff.net>
- Date
- Sep 27, 2018, 06:48 UTC
- Message-ID
- <20180927064836.GA13130@sigill.intra.peff.net>
- In-Reply-To
- <20180926185812.GD30680@sigill.intra.peff.net>
On Wed, Sep 26, 2018 at 02:58:12PM -0400, Jeff King wrote:
> And if we were going to generate something external, would it make more > sense to write in a structured format like doxygen? I am not a big fan > of it myself, but at least from there you can generate a more richly > interconnected set of documentation.
By the way, I tried running Doxygen on the current code-base. I _still_ hate the presentation of it (mostly because it's jarring to jump out of my terminal to a web browser). But it actually does an OK job of showing strbuf.h, with our overview attached to the struct and individual functions correctly documented. There are a couple of formatting hiccups, but it's actually pretty close.
-Peff