0.5.0 • Published 8 years ago

mello v0.5.0

Weekly downloads
2
License
MIT
Repository
github
Last release
8 years ago

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

  1. Run doxygen to generate the XML documentation.
  2. 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)