0e/bf9a07bb5a9faf7cf7c4a01a604bf85856dffb

   1 Return-Path: <jani@nikula.org>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id B3FA3431FC9\r
   6         for <notmuch@notmuchmail.org>; Sat, 30 Nov 2013 07:43:05 -0800 (PST)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: -0.7\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
  12         tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id V3CGrwXr6OHN for <notmuch@notmuchmail.org>;\r
  16         Sat, 30 Nov 2013 07:42:58 -0800 (PST)\r
  17 Received: from mail-lb0-f179.google.com (mail-lb0-f179.google.com\r
  18         [209.85.217.179]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
  19         (No client certificate requested)\r
  20         by olra.theworths.org (Postfix) with ESMTPS id 85AB3431FAF\r
  21         for <notmuch@notmuchmail.org>; Sat, 30 Nov 2013 07:42:58 -0800 (PST)\r
  22 Received: by mail-lb0-f179.google.com with SMTP id l4so7757531lbv.10\r
  23         for <notmuch@notmuchmail.org>; Sat, 30 Nov 2013 07:42:57 -0800 (PST)\r
  24 X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
  25         d=1e100.net; s=20130820;\r
  26         h=x-gm-message-state:from:to:cc:subject:date:message-id;\r
  27         bh=v/qsVbvhuiAFb5a/LRqCc7oZkF3ao1yhgpomcoH08Vw=;\r
  28         b=W05d/FuZra/+7TB9ky/r+OvvhbVm22lxJVdXpvrZ62QROb0CSD8NdA32/XbGX4hQzP\r
  29         jpzw0CGeC+W6hMtf+4J3Cebip0OEKxrAXHRW48XfadT1ld4j6vZew6/VzJxDIyY9JhVK\r
  30         BJZbhdR03sQEnfVvpLGF4acJYAcQoXhPRCiomu3UEc5jLGU48JhJ7DH6J6Riq/MuXc+z\r
  31         FOomBnNP1yrFFzJCSqnA+4tlN1X7TtAJW8rRZmYagPMI4hZDtoEHaALPD1b+WAOejXDY\r
  32         5/Qspa5tk6SmpLyCr8EriMHDWCfScYkvq875CRAP0DGunaP2UTly/ETGnFhPRlN1ltl8\r
  33         kqRw==\r
  34 X-Gm-Message-State:\r
  35  ALoCoQmsDyKY/PTnxSMmPUgaVvXZ4HlUpVPUmytU2ucPD0GLzrBTf3o9n1TWboUAitBJNdhy2Bqq\r
  36 X-Received: by 10.152.7.67 with SMTP id h3mr115524laa.29.1385826177059;\r
  37         Sat, 30 Nov 2013 07:42:57 -0800 (PST)\r
  38 Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi.\r
  39         [88.195.111.91]) by mx.google.com with ESMTPSA id\r
  40         sd11sm69220949lab.2.2013.11.30.07.42.55 for <multiple recipients>\r
  41         (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
  42         Sat, 30 Nov 2013 07:42:56 -0800 (PST)\r
  43 From: Jani Nikula <jani@nikula.org>\r
  44 To: notmuch@notmuchmail.org\r
  45 Subject: [PATCH 0/2] library reference man page\r
  46 Date: Sat, 30 Nov 2013 17:42:50 +0200\r
  47 Message-Id: <cover.1385826040.git.jani@nikula.org>\r
  48 X-Mailer: git-send-email 1.8.4.2\r
  49 X-BeenThere: notmuch@notmuchmail.org\r
  50 X-Mailman-Version: 2.1.13\r
  51 Precedence: list\r
  52 List-Id: "Use and development of the notmuch mail system."\r
  53         <notmuch.notmuchmail.org>\r
  54 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  55         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  56 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  57 List-Post: <mailto:notmuch@notmuchmail.org>\r
  58 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  59 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  60         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  61 X-List-Received-Date: Sat, 30 Nov 2013 15:43:05 -0000\r
  62 \r
  63 v1 after RFC at id:cover.1383758666.git.jani@nikula.org.\r
  64 \r
  65 These two patches add a doxygen configuration file and minimal changes\r
  66 to lib/notmuch.h to produce man/man3/notmuch.3 library reference.\r
  67 \r
  68 Apply patches, and run\r
  69  $ doxygen devel/doxygen.cfg\r
  70  $ man man/man3/notmuch.3\r
  71 \r
  72 There's still plenty to do, but perhaps we could get started with\r
  73 merging this? There's no harm done, and would help collaboration on\r
  74 this.\r
  75 \r
  76 TODO:\r
  77 \r
  78 * make this part of the build/install process\r
  79 * check version in release checks\r
  80 * figure out how to *not* create a file list man page\r
  81 * upload the man page to the web site\r
  82 * generate html pages too, and upload to web site also\r
  83 * start using doxygen/javadoc tags to produce nicer output\r
  84 \r
  85 Cheers,\r
  86 Jani.\r
  87 \r
  88 \r
  89 Jani Nikula (2):\r
  90   devel: add doxygen configuration file\r
  91   lib: modify notmuch.h for automatic document generation\r
  92 \r
  93  devel/doxygen.cfg | 1890 +++++++++++++++++++++++++++++++++++++++++++++++++++++\r
  94  lib/notmuch.h     |  436 ++++++++----\r
  95  2 files changed, 2186 insertions(+), 140 deletions(-)\r
  96  create mode 100644 devel/doxygen.cfg\r
  97 \r
  98 -- \r
  99 1.8.4.2\r
 100 \r