Index: utils/dartdoc/README.txt |
diff --git a/utils/dartdoc/README.txt b/utils/dartdoc/README.txt |
index 01eb65269174dc4b0b45cf0268c32a9a714aae4c..440b020e161da88959272843d1366e36d35962e9 100644 |
--- a/utils/dartdoc/README.txt |
+++ b/utils/dartdoc/README.txt |
@@ -4,10 +4,21 @@ To use it, from this directory, run: |
$ dartdoc <path to .dart file> |
-This will create a "docs" directory with the docs for your libraries. To do so, |
-dartdoc parses that library and every library it imports. From each library, it |
-parses all classes and members, finds the associated doc comments and builds |
-crosslinked docs from them. |
+This will create a "docs" directory with the docs for your libraries. The |
+easiest way to preview your generated docs is to spin up a little web server, |
+like: |
+ |
+ $ python -m SimpleHTTPServer |
+ |
+Then point your browser at `localhost:8000` to see your magnificent creation. |
sethladd
2011/12/01 04:50:33
Probably don't need this anymore.
Bob Nystrom
2011/12/02 19:40:55
Done.
|
+ |
+ |
+How docs are generated |
+---------------------- |
+ |
+To make beatiful docs from your library, dartdoc parses it and every library it |
pquitslund
2011/12/01 23:29:54
beatiful -> beautiful
Bob Nystrom
2011/12/02 19:40:55
Done.
|
+imports (recursively). From each library, it parses all classes and members, |
+finds the associated doc comments and builds crosslinked docs from them. |
"Doc comments" can be in one of a few forms: |