{"repo":"wernsey/d.awk","free":true,"listed":false,"github":"https://github.com/wernsey/d.awk","clone":"git clone https://github.com/wernsey/d.awk.git","description":"An Awk script to generate documentation from Markdown comments in C/C++/Java/JavaScript/C# source code.","language":"Awk","stars":98,"topics":["awk","html-document","documentation-tool","documentation-generator","markdown"],"license":"MIT-0","category":"docs-static-sites","readme_excerpt":"d.awk - Source code documentation script ======================================== Some [Awk][] scripts to generate documentation from [Markdown][]-formatted comments in source code. The [d.awk][] script creates documentation for languages that use / / for multiline comments, like C, C++, Java, C#, JavaScript. The file [hashd.awk][] does the same, but for languages that use # symbols for comments, like Perl, Python, Ruby, and others. For example, add a comment like this to your source file: Then use Awk to run the d.awk script on it like so: The text within the / / comment blocks are parsed as Markdown, and rendered as HTML. Comments may also start with three slashes: /// Markdown here . A typical use case to bundle the d.awk script with your project's source and to then add a docs target to the Makefile: docs: api-doc.html api-doc.html: header.h d.awk $(AWK) -f d.awk $ $@ The script can also generate HTML from a normal Markdown document using the -v Clean=1 command-line option: There are additional scripts in the distribution: [hashd.awk][] - Like d.awk , but for languages that use # symbols for comments [mdown.awk][] - Generates HTML from a normal Markdown file. [xtract.awk][] - Extracts the Markdown comments of a source file. [wrap.awk][] - Formats a Markdown text file to fit on a page. [d.awk]: d.awk [hashd.awk]: hashd.awk [mdown.awk]: mdown.awk [xtract.awk]: xtract.awk [wrap.awk]: wrap.awk Features It supports most of Markdown: Bold , italic and monospaced text. Both head","default_branch":null,"files":null,"tree":[],"storefront":"/r/wernsey","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/wernsey/d.awk/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}