From 0667ca33120e33b56a167d91e75e40076a6b08dd Mon Sep 17 00:00:00 2001 From: Mike Bierlee Date: Fri, 1 May 2015 01:13:16 +0200 Subject: [PATCH] Add instructions for generating documentation from source --- .travis.yml | 1 + README.md | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/.travis.yml b/.travis.yml index 54756be..4862171 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,3 +5,4 @@ script: - dub test --build=unittest --config=unittest - dub build --build=release --config=quickstartExample - dub build --build=release --config=qualifiersExample + - dub build --build=ddox diff --git a/README.md b/README.md index 523a791..62b836a 100644 --- a/README.md +++ b/README.md @@ -141,6 +141,14 @@ class BluePaint { ``` If you registered multiple concrete types to the same supertype and you do not resolve using a qualifier, a ResolveException is thrown stating that there are multiple candidates for the type to be resolved. +Documentation +------------- +You can generate Public API documentation from the source code using DUB: +``` +dub build --build=ddox +``` +The documentation can then be found in docs/ + Future Work ----------- * Component scan (auto-registration)