[PATCH 0/2] library reference man page

[Jani Nikula]

On Sat, 30 Nov 2013, David Bremner <david at tethera.net> wrote:
> Jani Nikula <jani at nikula.org> writes:
>>
>>  devel/doxygen.cfg | 1890 +++++++++++++++++++++++++++++++++++++++++++++++++++++
>>  lib/notmuch.h     |  436 ++++++++----
>
> A 2K line config file is kindof gross, but other than that, I think the
> idea has merit. Do we really need that much configuration info?

The config file is basically a template generated with 'doxygen -g' and
adjusted to our needs. It could be significantly reduced by dropping
comments, defaults, and unused settings. Maybe that would be the right
thing to do, even if the comments and defaults that are set explicitly
serve as documentation.

> Perhaps a quibble, but at least for me the summary part of the resulting
> manpage is almost unreadable because of the amount of underlining.

Agreed, it's not optimal. I was hoping someone more experienced with
doxygen would fix that after I shared this initial work. ;)

BR,
Jani.