1 // just docs: Tips on using adrdox
2 /++
3 $(LIST
4 	* Always have a package.d for your package, even if it contains no declarations.
5 	* Always use a module declaration on all modules, and always put a comment on it.
6 	* Always put a ddoc comment on a public decl, even if it is an empty comment.
7 	* Want an index.html generated? Run adrdox on a `module index;` (this is a filthy hack but it works)
8 )
9 
10 adrdox will not descend into undocumented entities, so a missing doc comment on a top level
11 declaration will make all effort in documenting inner items useless. If you do not document
12 a module declaration, the whole module is skipped!
13 +/
14 module adrdox.tips;
Suggestion Box / Bug Report