mk_doxygen_html — Generate html documentation
mk_doxygen_html INPUT=input_list
INPUT=input_list
a list of files that should be processed by doxygen
HEADERDIRS=dir_list
a list of source directories relative to the current MakeKitBuild where public header files are installed (e.g. by mk_headers). The headers will be added to the input list automatically.
DOXYFILE
a Doxygen configuration file to use. If not specified, defaults to Doxyfile. The file should not specify any options controlling input or output files as they will be filled in automatically.
INSTALLDIR=dir
where to install the html documentation. Defaults to $MK_HTMLDIR/doxygen.
Processes the specified input file and headers with doxygen
and outputs documentation in html format. You must provide
a Doxyfile in the current directory (or override the path
using DOXYFILE=doxyfile) to control
any customizable Doxygen settings.
To use this function, you must use mk_check_doxygen
in a configure section of your project, and it must succeed.
You can test whether Doxygen was found with mk_have_doxygen.
This function will abort if Doxygen is unavailable.