Index: utils/apidoc/README.txt |
diff --git a/utils/apidoc/README.txt b/utils/apidoc/README.txt |
index 3d892c0f281742758d02ca1d7664db1f524439b8..88e505d2c51f2ca372b27c9a0d0c34879395c705 100644 |
--- a/utils/apidoc/README.txt |
+++ b/utils/apidoc/README.txt |
@@ -1,8 +1,10 @@ |
+Apidoc is a specialization of Dartdoc. |
Dartdoc generates static HTML documentation from Dart code. |
+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. |