From: Jani Nikula <jani@nikula.org>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: Re: [PATCH 0/2] library reference man page
Date: Sat, 30 Nov 2013 23:35:19 +0200 [thread overview]
Message-ID: <87r49xshd4.fsf@nikula.org> (raw)
In-Reply-To: <87haat4pws.fsf@zancas.localnet>
On Sat, 30 Nov 2013, David Bremner <david@tethera.net> wrote:
> Jani Nikula <jani@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.
next prev parent reply other threads:[~2013-11-30 21:40 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-11-30 15:42 [PATCH 0/2] library reference man page Jani Nikula
2013-11-30 15:42 ` [PATCH 1/2] devel: add doxygen configuration file Jani Nikula
2013-12-01 9:39 ` [PATCH] " Jani Nikula
2013-11-30 15:42 ` [PATCH 2/2] lib: modify notmuch.h for automatic document generation Jani Nikula
2014-01-01 15:00 ` Tomi Ollila
2013-11-30 20:04 ` [PATCH 0/2] library reference man page David Bremner
2013-11-30 21:35 ` Jani Nikula [this message]
2014-01-01 14:15 ` Tomi Ollila
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87r49xshd4.fsf@nikula.org \
--to=jani@nikula.org \
--cc=david@tethera.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).