76
GitHub - r-lyeh/stddoc.c: Tiny documentation generator for 60 programming langua...
source link: https://github.com/r-lyeh/stddoc.c
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
stddoc.c
- stddoc.c is a tiny documentation generator for 60 programming languages.
- Check auto-generated sample page here
How does it work?
- Markdeep code comments are extracted from stdin and printed into stdout as a HTML file.
Usage
stddoc < source.code > documentation.htmltype *.code | stddoc > documentation.html
Supported languages
| Language | /// comment |
--- comment |
### comment |
|---|---|---|---|
| ActionScript | Yes | ||
| Ada | Yes | ||
| AngelScript | Yes | ||
| AppleScript | Yes | ||
| AWK | Yes | ||
| Bash | Yes | ||
| Bourne shell | Yes | ||
| C (C99) | Yes | ||
| C shell | Yes | ||
| C# | Yes | ||
| C++ | Yes | ||
| ChaiScript | Yes | ||
| Cobra | Yes | ||
| D | Yes | ||
| Dao | Yes | ||
| Eiffel | Yes | ||
| Euphoria | Yes | ||
| GameMonkey | Yes | ||
| GML | Yes | ||
| Go | Yes | ||
| Haskell | Yes | ||
| Java | Yes | ||
| JavaScript | Yes | ||
| JetScript | Yes | ||
| jtc | Yes | ||
| Jx9 | Yes | ||
| Kotlin | Yes | ||
| Lua | Yes | ||
| Maple | Yes | ||
| Neko | Yes | ||
| Object Pascal (Delphi) | Yes | ||
| Objective-C | Yes | ||
| Occam | Yes | ||
| Pawn | Yes | ||
| Perl | Yes | ||
| Perl6 | Yes | ||
| PHP | Yes | Yes | |
| PowerShell | Yes | ||
| PSL | Yes | ||
| Python | Yes | ||
| QuakeC | Yes | ||
| R | Yes | ||
| Ruby | Yes | ||
| Rust | Yes | ||
| SASS | Yes | ||
| Scala | Yes | ||
| Seed7 | Yes | ||
| SGML | Yes | ||
| SGScript | Yes | ||
| SPARK | Yes | ||
| SQL | Yes | ||
| Squirrel | Yes | ||
| Swift | Yes | ||
| Tcl | Yes | ||
| Terra | Yes | ||
| TSQL | Yes | ||
| Vala | Yes | ||
| VHDL | Yes | ||
| Wren | Yes | ||
| Xojo | Yes |
License
- Unlicensed (~Public Domain).
- Using API doc style created by Aras Pranckevičius.
- Using Markdeep by Morgan McGuire.
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK