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 with the command line application on the terminal you just do something like this tclsh mkdoc.tcl inputfile outputfile. For example to extract mkdoc's own documentation you could use:
tclsh mkdoc.tcl mkdoc.tcl mkdoc.html
Or if you would like to have pdf output and if you have pandoc installed:
tclsh mkdoc.tcl mkdoc.tcl mkdoc.md pandoc mkdoc.md -o mkdoc.pdf
If you do this pdf conversion, you might add before the pandoc conversion the YAML header again as this header is not Markdown syntax and might not display correctly in Markdown viewers.
Changes:
See also: