Index: utils/apidoc/README.txt |
diff --git a/utils/apidoc/README.txt b/utils/apidoc/README.txt |
index 3d892c0f281742758d02ca1d7664db1f524439b8..a53a1ad3f1c13db48ce06dc963592169c820bc02 100644 |
--- a/utils/apidoc/README.txt |
+++ b/utils/apidoc/README.txt |
@@ -1,8 +1,10 @@ |
-Dartdoc generates static HTML documentation from Dart code. |
+Apidoc is a specialization of dartdoc. |
+dartdoc generates static HTML documentation from Dart code. |
Bob Nystrom
2012/03/28 20:01:21
I would capitalize "Dartdoc" here since it starts
sethladd
2012/03/28 21:52:17
Done.
|
+Apidoc wraps the dartdoc output with official dartlang.org skin, comments, etc. |
To use it, from this directory, run: |
- $ dartdoc <path to .dart file> |
+ $ dart apidoc.dart [--out=<output directory>] |
This will create a "docs" directory with the docs for your libraries. |