OLD | NEW |
| 1 Apidoc is a specialization of Dartdoc. |
1 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. |
2 | 4 |
3 To use it, from this directory, run: | 5 To use it, from this directory, run: |
4 | 6 |
5 $ dartdoc <path to .dart file> | 7 $ dart apidoc.dart [--out=<output directory>] |
6 | 8 |
7 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. |
8 | 10 |
9 | 11 |
10 How docs are generated | 12 How docs are generated |
11 ---------------------- | 13 ---------------------- |
12 | 14 |
13 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 |
14 imports (recursively). From each library, it parses all classes and members, | 16 imports (recursively). From each library, it parses all classes and members, |
15 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... |
75 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 |
76 member where that comment appears. Dartdoc will automatically figure out what | 78 member where that comment appears. Dartdoc will automatically figure out what |
77 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. |
78 | 80 |
79 | 81 |
80 Attribution | 82 Attribution |
81 ----------- | 83 ----------- |
82 | 84 |
83 dartdoc uses the delightful Silk icon set by Mark James. | 85 dartdoc uses the delightful Silk icon set by Mark James. |
84 http://www.famfamfam.com/lab/icons/silk/ | 86 http://www.famfamfam.com/lab/icons/silk/ |
OLD | NEW |