| 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. | 7 This will create a "docs" directory with the docs for your libraries. |
| 8 | 8 |
| 9 | 9 |
| 10 How docs are generated | 10 How docs are generated |
| (...skipping 27 matching lines...) Expand all Loading... |
| 38 /// * And can have multiple items. | 38 /// * And can have multiple items. |
| 39 /// 1. You can nest lists. | 39 /// 1. You can nest lists. |
| 40 /// 2. Like this numbered one. | 40 /// 2. Like this numbered one. |
| 41 /// | 41 /// |
| 42 /// --- | 42 /// --- |
| 43 /// | 43 /// |
| 44 /// Three dashes, underscores, or tildes on a line by themselves create a | 44 /// Three dashes, underscores, or tildes on a line by themselves create a |
| 45 /// horizontal rule. | 45 /// horizontal rule. |
| 46 /// | 46 /// |
| 47 /// to.get(a.block + of.code) { | 47 /// to.get(a.block + of.code) { |
| 48 /// indent(it, 4.lines); | 48 /// indent(it, 4.spaces); |
| 49 /// like(this); | 49 /// like(this); |
| 50 /// } | 50 /// } |
| 51 /// | 51 /// |
| 52 /// There are a few inline styles you can apply: *emphasis*, **strong**, | 52 /// There are a few inline styles you can apply: *emphasis*, **strong**, |
| 53 /// and `inline code`. You can also use underscores for _emphasis_ and | 53 /// and `inline code`. You can also use underscores for _emphasis_ and |
| 54 /// __strong__. | 54 /// __strong__. |
| 55 /// | 55 /// |
| 56 /// An H1 header using equals on the next line | 56 /// An H1 header using equals on the next line |
| 57 /// ========================================== | 57 /// ========================================== |
| 58 /// | 58 /// |
| (...skipping 16 matching lines...) Expand all Loading... |
| 75 is understood to be the name of some member or type that's in the scope of the | 75 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 | 76 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. | 77 the name refers to and generate an approriate link to that member or type. |
| 78 | 78 |
| 79 | 79 |
| 80 Attribution | 80 Attribution |
| 81 ----------- | 81 ----------- |
| 82 | 82 |
| 83 dartdoc uses the delightful Silk icon set by Mark James. | 83 dartdoc uses the delightful Silk icon set by Mark James. |
| 84 http://www.famfamfam.com/lab/icons/silk/ | 84 http://www.famfamfam.com/lab/icons/silk/ |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 8958013:
Fix typo in dartdoc README. (Closed)
Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart