Version 4 of mkdoc::mkdoc

Updated 2019-11-19 05:01:06 by DDG

mkdoc::mkdoc

Source code documentation tool using Markdown as markup languages directly inside the code. Can be installed as a single file command line application or as a normal Tcl package. It support programming languages like Python, Tcl, Perl. Markdown Syntax is just prefixed with a #'. Also languages with multi line comments like C++ are supported, just use inside the /* ... */ code blocks as well the #' prefix. A good example for the documentation is mkdoc::mkdoc own manual page.

To extract the documentation on the terminal you just do something like this:

tclsh mkdoc.tcl mkdoc.html

Or if you would like to have pdf output and if you have pandoc installed:

tclsh mkdoc.tcl mkdoc.md
pandoc mkdoc.md -o mkdoc.pdf

See also: