Add Doxygen support to build system to build the API doc
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Wed, 16 Nov 2016 05:48:28 +0000 (00:48 -0500)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Sat, 27 May 2017 18:09:07 +0000 (14:09 -0400)
commitd1dab1d2126585017a17c35e05e9873d995bfee2
tree69fa688c612fc9bdd44dee73b36f61c931797e38
parent24626e8bc3516dd3b075489b42576c9045070b4a
Add Doxygen support to build system to build the API doc

This patch adds what is needed to generate the HTML documentation
of Babeltrace's C API using Doxygen to look for documentation source
in selected header files.

The new configure option --enable-api-doc enables the API doc
build using Doxygen (Doxygen must be found in this case). Whether or
not this API doc is built is indicated in the summary at the end of
the configure script execution.

Doxygen's input is doc/api/Doxyfile.in. This file has a few
substitutions like the project's version and the paths to input
files.

The API doc target, if enabled with the configure option, is part of
the `all` target.

With the `install` target, the files are installed in
$(DESTDIR)$(docdir)/api, e.g. /usr/share/doc/babeltrace/api.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
configure.ac
doc/Makefile.am
doc/api/Doxyfile.in [new file with mode: 0644]
doc/api/Makefile.am [new file with mode: 0644]
doc/api/dox/group-api-ref.dox [new file with mode: 0644]
doc/api/dox/group-ctf-ir.dox [new file with mode: 0644]
doc/api/dox/main-page.dox [new file with mode: 0644]
doc/api/dox/quick-start.dox [new file with mode: 0644]
doc/api/images/ctf-stream-packet.png [new file with mode: 0644]
m4/ax_prog_doxygen.m4 [new file with mode: 0644]
This page took 0.024973 seconds and 4 git commands to generate.