From 2e948c8f1ac63c0a74f2a6148d5b6ae1251648df Mon Sep 17 00:00:00 2001 From: Jani Nikula Date: Sat, 30 Nov 2013 23:35:19 +0200 Subject: [PATCH] Re: [PATCH 0/2] library reference man page --- 5e/e1cfb3f6008322a67893d0de320af65dba39f5 | 93 +++++++++++++++++++++++ 1 file changed, 93 insertions(+) create mode 100644 5e/e1cfb3f6008322a67893d0de320af65dba39f5 diff --git a/5e/e1cfb3f6008322a67893d0de320af65dba39f5 b/5e/e1cfb3f6008322a67893d0de320af65dba39f5 new file mode 100644 index 000000000..8e82d70d1 --- /dev/null +++ b/5e/e1cfb3f6008322a67893d0de320af65dba39f5 @@ -0,0 +1,93 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 2ABC8431FD0 + for ; Sat, 30 Nov 2013 13:40:41 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.7 +X-Spam-Level: +X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id X0YicW9kGndd for ; + Sat, 30 Nov 2013 13:40:35 -0800 (PST) +Received: from mail-ea0-f169.google.com (mail-ea0-f169.google.com + [209.85.215.169]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id BCBEB431FAF + for ; Sat, 30 Nov 2013 13:40:34 -0800 (PST) +Received: by mail-ea0-f169.google.com with SMTP id l9so7956002eaj.28 + for ; Sat, 30 Nov 2013 13:40:29 -0800 (PST) +X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=1e100.net; s=20130820; + h=x-gm-message-state:from:to:subject:in-reply-to:references + :user-agent:date:message-id:mime-version:content-type; + bh=kv055V59BnGuoAzTnFGPpGAJUQPoRdzF0O7nmIgCFv0=; + b=C0t7BL8a9J283McIR2zuSuBWiEP6Deh8eqGgQymW/O5+rbXaM4wOgmeTAxn/GkbHa5 + OTfHhNZjkp1XsmTcP+aT5fos4cIe83ftc8QjrSogdKelQ8IEMyA3ZwGafD+9M8FCqPWn + XufmtCoL7xkP4K0LgclqMYQ/DC1m6J3I9GnRPZAsXo42yd6xK0eBfV1NRnP15wx5enyv + NlZAK5tnvCtfReOvv/xEXy1COi7IbqkFc3T9ZJpsNfMM/GWOuZKwnspOwupwHlaoOQQC + SmXcuecnsb/7eBBUODH3eTN7u0VvZ0sNfIutKPnfS7BGKv5u0XoEQqPmug0GcQvuCNxr + FIwA== +X-Gm-Message-State: + ALoCoQn5KZG5Ybk71FNh8x1eCCTr+GlehO7Cy1f/I1XBzrWFQrPfcxucQLr2PRiWi4C8mr9B9gTa +X-Received: by 10.15.53.193 with SMTP id r41mr2806156eew.2.1385847324380; + Sat, 30 Nov 2013 13:35:24 -0800 (PST) +Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi. + [88.195.111.91]) + by mx.google.com with ESMTPSA id g1sm54513090eew.1.2013.11.30.13.35.22 + for + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Sat, 30 Nov 2013 13:35:23 -0800 (PST) +From: Jani Nikula +To: David Bremner , notmuch@notmuchmail.org +Subject: Re: [PATCH 0/2] library reference man page +In-Reply-To: <87haat4pws.fsf@zancas.localnet> +References: + <87haat4pws.fsf@zancas.localnet> +User-Agent: Notmuch/0.16+145~gebbaa94 (http://notmuchmail.org) Emacs/24.3.1 + (x86_64-pc-linux-gnu) +Date: Sat, 30 Nov 2013 23:35:19 +0200 +Message-ID: <87r49xshd4.fsf@nikula.org> +MIME-Version: 1.0 +Content-Type: text/plain +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sat, 30 Nov 2013 21:40:41 -0000 + +On Sat, 30 Nov 2013, David Bremner wrote: +> Jani Nikula 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. -- 2.26.2