| OLD | NEW |
|---|
| 1 Apidoc is a specialization of Dartdoc. | 1 Apidoc is a specialization of Dartdoc. |
| 2 Dartdoc generates static HTML documentation from Dart code. | 2 Dartdoc generates static HTML documentation from Dart code. |
| 3 Apidoc wraps the dartdoc output with official dartlang.org skin, comments, etc. | 3 Apidoc wraps the dartdoc output with official dartlang.org skin, comments, etc. |
| 4 | 4 |
| 5 To use it, from this directory, run: | 5 To use it, from the top level dart directory, run: |
| 6 | 6 |
| 7 $ dart apidoc.dart [--out=<output directory>] | 7 $ dart utils/apidoc/apidoc.dart [--out=<output directory>] |
| 8 | 8 |
| 9 This will create a "docs" directory with the docs for your libraries. | 9 This will create a "docs" directory with the docs for your libraries. |
| 10 | 10 |
| 11 | 11 |
| 12 How docs are generated | 12 How docs are generated |
| 13 ---------------------- | 13 ---------------------- |
| 14 | 14 |
| 15 To make beautiful docs from your library, dartdoc parses it and every library it | 15 To make beautiful docs from your library, dartdoc parses it and every library it |
| 16 imports (recursively). From each library, it parses all classes and members, | 16 imports (recursively). From each library, it parses all classes and members, |
| 17 finds the associated doc comments and builds crosslinked docs from them. | 17 finds the associated doc comments and builds crosslinked docs from them. |
| (...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 77 is understood to be the name of some member or type that's in the scope of the | 77 is understood to be the name of some member or type that's in the scope of the |
| 78 member where that comment appears. Dartdoc will automatically figure out what | 78 member where that comment appears. Dartdoc will automatically figure out what |
| 79 the name refers to and generate an approriate link to that member or type. | 79 the name refers to and generate an approriate link to that member or type. |
| 80 | 80 |
| 81 | 81 |
| 82 Attribution | 82 Attribution |
| 83 ----------- | 83 ----------- |
| 84 | 84 |
| 85 dartdoc uses the delightful Silk icon set by Mark James. | 85 dartdoc uses the delightful Silk icon set by Mark James. |
| 86 http://www.famfamfam.com/lab/icons/silk/ | 86 http://www.famfamfam.com/lab/icons/silk/ |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 10389223:
Add unittest to apidoc and fix readme. (Closed)
Base URL: http://dart.googlecode.com/svn/branches/bleeding_edge/dart/