adrdox

Articles

Get Help
Article adrdox.help

Need help with D? Can't find it here? The D community strives to be friendly and approachable, you can always ask us!

adrdox skeleton file layout
Article adrdox.skeleton

The skeleton file is a html file with two required elements: #page-nav and #page-content. You can put them anywhere and whatever you want around them.

adrdox syntax
Article 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
Article 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

highlight
module adrdox.highlight

$(ADRDOX_SAMPLE

Meta

Suggestion Box / Bug Report