[PATCH 0/2] library reference man page
Jani Nikula
jani at nikula.org
Sat Nov 30 07:42:50 PST 2013
v1 after RFC at id:cover.1383758666.git.jani at nikula.org.
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 | 436 ++++++++----
2 files changed, 2186 insertions(+), 140 deletions(-)
create mode 100644 devel/doxygen.cfg
--
1.8.4.2
More information about the notmuch
mailing list