GenDocs is a utility for easily creating documentation for AutoHotkey libraries.
- Inner classes
See Demo/TestLib.ahk to get a grasp of the syntax (TODO: document more thoroughly).
GenDocs uses a stripped down version of Markdown, which supports:
- Paragraphs: blocks of text delimited by blank lines. Equivalent to HTML
- In-paragraph line breaks: end a line with two spaces. Equivalent to HTML
- Headings: start a line with up to three hash (
#) characters, followed by space. Equivalent to HTML
- Emphasis marks: *...*. Equivalent to HTML
- Strong emphasis marks: **...**. Equivalent to HTML
- Inline code marks: `...`. Equivalent to HTML
- Code sections: unlike standard Markdown, they use the blockquote syntax: blocks of text whose lines start with > followed by a space.
- Unordered lists: lines that start with *. Equivalent to HTML
- Ordered lists: lines that start with a number, dot and space (e.g.
1.); or letter, dot and space (e.g.
a.). Equivalent to HTML
<ol style="list-style-type: lower-alpha">...</ol>respectively.
- Escape sequences: the sequences \*, \`, \[, \], \! and \\ are recognized, and yield literal characters.
[Link text](Link URL). Equivalent to HTML
![Image ALT text](Image file name). Equivalent to HTML
<img src="..." alt="..."/>.
- "Related" section support
- Better AutoHotkey code comment highlighter
- CHM generation