adrdox

Articles

adrdox syntax

module adrdox.syntax

This document describes the syntax recognized by my documentation generator. It uses a hybrid of ddoc and markdown syntax, with some customizations and pre-defined styles I like, while not supporting things I feel aren't worth the hassle.

Tips on using adrdox

module adrdox.tips

• Always have a package.d for your package, even if it contains no declarations.
• Always use a module declaration on all modules, and always put a comment on it.
• Always put a ddoc comment on a public decl, even if it is an empty comment.
• Want an index.html generated? Run adrdox on a module index; (this is a filthy hack but it works)

Modules

jstex

module adrdox.jstex

Undocumented in source.

latex

module adrdox.latex

Undocumented in source.

locate

module adrdox.locate

Undocumented in source.

main

module adrdox.main

Undocumented in source.

• PorterStemmer
• adrdox
• arsd
• dparse
• dpldocs
• dscanner
• std