Chromium Code Reviews| OLD | NEW |
|---|---|
| 1 Dartdoc generates static HTML documentation from Dart code. | 1 Dartdoc generates static HTML documentation from Dart code. |
| 2 | 2 |
| 3 To use it, from this directory, run: | 3 To use it, from this directory, run: |
| 4 | 4 |
| 5 $ dartdoc <path to .dart file> | 5 $ dartdoc <path to .dart file> |
| 6 | 6 |
| 7 This will create a "docs" directory with the docs for your libraries. To do so, | 7 This will create a "docs" directory with the docs for your libraries. The |
| 8 dartdoc parses that library and every library it imports. From each library, it | 8 easiest way to preview your generated docs is to spin up a little web server, |
| 9 parses all classes and members, finds the associated doc comments and builds | 9 like: |
| 10 crosslinked docs from them. | 10 |
| 11 $ python -m SimpleHTTPServer | |
| 12 | |
| 13 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.
| |
| 14 | |
| 15 | |
| 16 How docs are generated | |
| 17 ---------------------- | |
| 18 | |
| 19 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.
| |
| 20 imports (recursively). From each library, it parses all classes and members, | |
| 21 finds the associated doc comments and builds crosslinked docs from them. | |
| 11 | 22 |
| 12 "Doc comments" can be in one of a few forms: | 23 "Doc comments" can be in one of a few forms: |
| 13 | 24 |
| 14 /** | 25 /** |
| 15 * JavaDoc style block comments. | 26 * JavaDoc style block comments. |
| 16 */ | 27 */ |
| 17 | 28 |
| 18 /** Which can also be single line. */ | 29 /** Which can also be single line. */ |
| 19 | 30 |
| 20 /// Triple-slash line comments. | 31 /// Triple-slash line comments. |
| (...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 63 | 74 |
| 64 There is also an extension to markdown specific to dartdoc: A name inside | 75 There is also an extension to markdown specific to dartdoc: A name inside |
| 65 square brackets that is not a markdown link (i.e. doesn't have square brackets | 76 square brackets that is not a markdown link (i.e. doesn't have square brackets |
| 66 or parentheses following it) like: | 77 or parentheses following it) like: |
| 67 | 78 |
| 68 Calls [someMethod], passing in [arg]. | 79 Calls [someMethod], passing in [arg]. |
| 69 | 80 |
| 70 is understood to be the name of some member or type that's in the scope of the | 81 is understood to be the name of some member or type that's in the scope of the |
| 71 member where that comment appears. Dartdoc will automatically figure out what | 82 member where that comment appears. Dartdoc will automatically figure out what |
| 72 the name refers to and generate an approriate link to that member or type. | 83 the name refers to and generate an approriate link to that member or type. |
| OLD | NEW |