From 4751ee66844c8669def0f885e67f1392ae886355 Mon Sep 17 00:00:00 2001 From: Jani Nikula Date: Wed, 6 Nov 2013 19:35:39 +0200 Subject: [PATCH] [RFC PATCH 0/2] library reference man page --- 63/a4a51e3263ffa59e34e73cbcf2eed2ebe23274 | 100 ++++++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 63/a4a51e3263ffa59e34e73cbcf2eed2ebe23274 diff --git a/63/a4a51e3263ffa59e34e73cbcf2eed2ebe23274 b/63/a4a51e3263ffa59e34e73cbcf2eed2ebe23274 new file mode 100644 index 000000000..cc52f4dd2 --- /dev/null +++ b/63/a4a51e3263ffa59e34e73cbcf2eed2ebe23274 @@ -0,0 +1,100 @@ +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 9DCC7429E59 + for ; Wed, 6 Nov 2013 10:01:30 -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 Mb4dW23dVwux for ; + Wed, 6 Nov 2013 10:01:23 -0800 (PST) +Received: from mail-ea0-f178.google.com (mail-ea0-f178.google.com + [209.85.215.178]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id E206E429E53 + for ; Wed, 6 Nov 2013 10:01:22 -0800 (PST) +Received: by mail-ea0-f178.google.com with SMTP id a10so1968374eae.23 + for ; Wed, 06 Nov 2013 10:01:21 -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:cc:subject:date:message-id; + bh=uMjV3hGG2SXO7kDiehfnoxtKmSxIV0ffp5V7FfBJzJI=; + b=VGdWVZvuip8S/i3HpQVTdgV/4lgAWilNfM6u6/dvsoGN571KyqQITH650GqYo9BirS + GncD9Bwj0CnRoqZz4NZLhUqVSjO0Yzbwv4vtrhsCEFf7G3yyIFgxbGOsVOYY4sopgnjK + KrrC6/kuPBwY+tpkMQW8f8v1+fvx8sqTkYZvAzt9tvFvQgrb4KYjPcz2cOMbVM0/Dl7J + APWd1z3eGxqmItRvw6nl9HCulODABmIIhop0dWY9FmPL/p4//5hc1lAy2K9K7rXLESCs + sZK/x/vxucQ837e2k+HUe2Lps5IuJDluzI/AYLPFRDEbU5/s8/S2gJOcV/r2So7UliIZ + wDZg== +X-Gm-Message-State: + ALoCoQmRLieQeiCQL8a7nXbXWQG/B1Br5fcSwdcqCHclBe8ni3IFzN2kwc796fq/gtdARbBRRWcF +X-Received: by 10.15.73.130 with SMTP id h2mr4872316eey.56.1383759344799; + Wed, 06 Nov 2013 09:35:44 -0800 (PST) +Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi. + [88.195.111.91]) + by mx.google.com with ESMTPSA id b42sm76321235eem.9.2013.11.06.09.35.42 + for + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Wed, 06 Nov 2013 09:35:43 -0800 (PST) +From: Jani Nikula +To: notmuch@notmuchmail.org +Subject: [RFC PATCH 0/2] library reference man page +Date: Wed, 6 Nov 2013 19:35:39 +0200 +Message-Id: +X-Mailer: git-send-email 1.8.4.rc3 +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: Wed, 06 Nov 2013 18:01:30 -0000 + +These two patches add a doxygen configuration file and minimal changes +to lib/notmuch.h to produce man/man3/notmuch.3 library reference. + +Apply patches, and run + $ doxygen devel/doxygen.cfg + $ man man/man3/notmuch.3 + +There's still plenty to do, but perhaps we could get started with +merging this? There's no harm done, and would help collaboration on +this. + +TODO: + +* make this part of the build/install process +* check version in release checks +* figure out how to *not* create a file list man page +* upload the man page to the web site +* generate html pages too, and upload to web site also +* start using doxygen/javadoc tags to produce nicer output + + +Cheers, +Jani. + + +Jani Nikula (2): + devel: add doxygen configuration file + lib: modify notmuch.h for automatic document generation + + devel/doxygen.cfg | 1890 +++++++++++++++++++++++++++++++++++++++++++++++++++++ + lib/notmuch.h | 426 ++++++++---- + 2 files changed, 2179 insertions(+), 137 deletions(-) + create mode 100644 devel/doxygen.cfg + +-- +1.8.4.rc3 + -- 2.26.2