qiBuild documentation

qidoc.doxygen_project - Doxygen project

QiBuild

class qidoc.doxygen_project.DoxygenProject(doc_worktree, project, name, depends=None, dest=None)

A doc project using doxygen

in_doxyfile

In DoxyFile

out_doxyfile

Out DoxyFile

tagfile

TagFile

configure(**kwargs)

Create a correct Doxyfile in self.build_dir. * Force OUTPUT_DIRECTORY * Rewrite INPUT, EXAMPLE_PATH and IMAGE_PATH * Add @INCLUDE_PATH and @INCLUDE statements if we

have a template
build(**kwargs)

Run doxygen from the build directory

install(destdir)

Install

make_rel_paths(value)

Transform a relative path to the source into an absolute path (usable from a build directory).