From 1f595ed5dbaebcbb30b8b8e32ba0146f0f22a608 Mon Sep 17 00:00:00 2001 From: Tad Hardesty Date: Fri, 31 Aug 2018 16:30:18 -0700 Subject: [PATCH] Add dmdoc to root readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 8dc39530..7034e7ba 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,22 @@ locally built language server rather than the binary releases. [ls-readme]: ./src/langserver/README.md [vsc-src]: https://github.com/SpaceManiac/vscode-dm-langclient +## [Documentation Generator](src/dmdoc/) + +`dmdoc` is a simple Doxygen-esque documentation generator for DreamMaker code. +Files, macros, types, vars, and procs can be documented. Documentation comments +start with `/**` or `///` when preceding the documented item, or `/*!` or `//!` +when contained within it. + +By default, only documented types are included in the output, and types with +only a one-line note do not get their own `.html` page. The index shows the +contents of `code/README.md`, and other Markdown files within the `code` +directory are shown alongside documented DM files. + +If run in a Git repository, web links to source code are placed next to item +headings in the generated output; otherwise, file and line numbers are shown +but are not linked. + ## Building To build locally, begin by [installing Rust][rust] or updating your existing