Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(479)

Unified Diff: utils/dartdoc/README.txt

Issue 8758010: Create separate HTML pages for each type. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Get dartdoc working with latest frog. Created 9 years ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | utils/dartdoc/dartdoc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: utils/dartdoc/README.txt
diff --git a/utils/dartdoc/README.txt b/utils/dartdoc/README.txt
index 01eb65269174dc4b0b45cf0268c32a9a714aae4c..33fe186b7c95c7e38a83a1fd16659dba7854ff16 100644
--- a/utils/dartdoc/README.txt
+++ b/utils/dartdoc/README.txt
@@ -4,10 +4,15 @@ 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.
+
+
+How docs are generated
+----------------------
+
+To make beautiful docs from your library, dartdoc parses it and every library it
+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:
« no previous file with comments | « no previous file | utils/dartdoc/dartdoc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698