[RFC PATCH 0/2] library reference man page

Jani Nikula jani at nikula.org
Wed Nov 6 09:35:39 PST 2013


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



More information about the notmuch mailing list