cmake-extended-doxygen

This repository ships a custom integration of doxygen into cmake built on top of the default integration shipped with cmake.

While the default integration provides the function doxygen_add_docs to set up a target dedicated to documentation, it does not provide any means to collect doxygen’s input automatically. This forces the developer into having to manually specify and maintain a list of sources going into documentation as well as a list of include directories to be stripped by doxygen. Apart from the maintainance overhead, this also leads to redundancies: after all, the set of source files and include directories are already known to cmake, so there should be a way of leveraging this information when specifying doxygen’s input.

To automate the process of collecting doxygen’s input, this repository ships

• the custom target property GENERATE_DOXYGEN alongside its source file equivalent GENERATE_DOXYGEN to control which source files go into documentation,

• the function collect_doxygen_input() to automatically populate the list of sources and include directories passed to doxygen and

• the function doxygen_add_documentation() replacing doxygen_add_docs (it’s almost a drop-in-replacement).

Getting started

Please follow Getting started.

Modules

Currently, the following modules are shipped:

• DoxygenAddDocumentation
• ExtendedDoxygen

Known limitations

The implementation shipped in this repository is still in early development. Hence, there are some limitations to keep in mind when using cmake-extended-doxygen (apart from the usual things that apply to early development projects). Please consult Known limitations for a list of known limitations.

Indices and tables

• Index

• Search Page

License

Licensed under BSD 3-Clause License.