From 749b06f757cd0ecd02f21e24bc1afd224777a7aa Mon Sep 17 00:00:00 2001 From: Jani Nikula Date: Wed, 1 Jan 2014 19:52:52 +0200 Subject: [PATCH] [PATCH v2 0/2] doxygen generated library reference man page --- 80/5b122ffe266039948ca1ffa8bfc77ad58dfd83 | 86 +++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 80/5b122ffe266039948ca1ffa8bfc77ad58dfd83 diff --git a/80/5b122ffe266039948ca1ffa8bfc77ad58dfd83 b/80/5b122ffe266039948ca1ffa8bfc77ad58dfd83 new file mode 100644 index 000000000..bc0c89e07 --- /dev/null +++ b/80/5b122ffe266039948ca1ffa8bfc77ad58dfd83 @@ -0,0 +1,86 @@ +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 4128E431FC3 + for ; Wed, 1 Jan 2014 09:53:06 -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 k--T-8wUPpKv for ; + Wed, 1 Jan 2014 09:53:00 -0800 (PST) +Received: from mail-ea0-f181.google.com (mail-ea0-f181.google.com + [209.85.215.181]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 6487D431FAF + for ; Wed, 1 Jan 2014 09:53:00 -0800 (PST) +Received: by mail-ea0-f181.google.com with SMTP id m10so6012717eaj.12 + for ; Wed, 01 Jan 2014 09:52:59 -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=U45mDSspJqisBW9Ck+hCf+m9fr5tBAFSoZk+1wvFwIA=; + b=b6lD8P7Dus/ZCTebCTlMZrnHaUbiyFoDfL342yLGFW0Sz7T3H/Z07z8/lLhOc3Hneu + vyZWMBJTb+nawfwSiQTxuvr632jyu5s5vXFa/e4zGvGF8kDNZKyOGI4UhQoIBEw2cUXi + cEWX2Yhh0SSbb7Ct5V9tEhnivsO7grdMEcvEn2/0dKCwPl6yLXEgQkF8dR4XaGAkxm3U + BclKA08VSpBcRqUKmBTAuCB8F2g+ii95noYQf8ClaGQHDuDEyf2S13d/djqfcr0XImAB + pWitpNT0QCBGrrcq4Nb+r0c6tIUs+4NbJ91HuwQM5zm82H+OqrLdurIWahQpDuHx+Sku + 0gKw== +X-Gm-Message-State: + ALoCoQkZQ5EFoCMDPc8UwtyRXMvZzzl87mlXsifBmy2lu+PLwReYDfHJBKgX3H8sJs3Jhbziexnc +X-Received: by 10.14.5.12 with SMTP id 12mr65273116eek.9.1388598777730; + Wed, 01 Jan 2014 09:52:57 -0800 (PST) +Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi. + [88.195.111.91]) + by mx.google.com with ESMTPSA id 44sm128901350eek.5.2014.01.01.09.52.55 + for + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Wed, 01 Jan 2014 09:52:56 -0800 (PST) +From: Jani Nikula +To: notmuch@notmuchmail.org +Subject: [PATCH v2 0/2] doxygen generated library reference man page +Date: Wed, 1 Jan 2014 19:52:52 +0200 +Message-Id: +X-Mailer: git-send-email 1.8.5.2 +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, 01 Jan 2014 17:53:06 -0000 + +v2 of id:cover.1385826040.git.jani@nikula.org + +Rebase, minor tweaks since v1; the TODO in the referenced message above +is still valid. I suggest we get this merged as a starting point, so we +can collaborate on including a nice API man page (and possibly a HTML +API reference on the web page) for 0.18. + +BR, +Jani. + + +Jani Nikula (2): + devel: add doxygen configuration file + lib: modify notmuch.h for automatic document generation + + devel/doxygen.cfg | 304 +++++++++++++++++++++++++++++++++++++ + lib/notmuch.h | 443 +++++++++++++++++++++++++++++++++++++----------------- + 2 files changed, 606 insertions(+), 141 deletions(-) + create mode 100644 devel/doxygen.cfg + +-- +1.8.5.2 + -- 2.26.2