mello
v0.5.0
Published
Doxygen XML to Markdown documentation converter
Downloads
4
Maintainers
Readme
Mello
Mello is a doxygen XML to markdown converter that fills the need for developers who want beautiful and minimal documentation for their C++ projects.
The code is a heavily modified port of Fabrice Ferdinand's doxygen2md
with a focus on generating multi page documentation from doxygen modules.
Mello is the API documentation generator used by LibSourcey, and the result can be seen here.
Usage
- Run
doxygen
to generate the XML documentation. - Run
mello
providing the folder location of the XML documentation.
Usage: mello [options] <doxygen directory>
Options:
-h, --help output usage information
-V, --version output the version number
-v, --verbose verbose mode
-a, --anchors add anchors to internal links
-g, --modules output doxygen modules into separate files
-l, --language <lang> programming language
-t, --templates <dir> custom templates directory
-o, --output <file> output file (must contain %s when using modules)