ArturBa/doxydown

Doxygen comment styles into Markdown document

★ 0Forks 0PythonGitHub ↗Compare

README

Doxydown - documentation utility

Build Status codecov

tool to make your source code to Markdown document in few seconds

This tool allows you to transform your source file with doxygen styled comments into Markdown document.

Supported languages:

  • C

Supported comment styles:

/**
 * ... text ...
 */
/*!
 * ... text ...
 */

In both cases the intermediate *'s are optional, so

/*!
 ... text ...
*/

is also valid.

Program running:

./doxydown.py example/Test.h 

Also you can save your output to file

./doxydown.py example/Test.h -o example/Test.md

Contributors

ArturBa

Issues