| 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. |
| 8 dartdoc parses that library and every library it imports. From each library, it | 8 |
| 9 parses all classes and members, finds the associated doc comments and builds | 9 |
| 10 crosslinked docs from them. | 10 How docs are generated |
| 11 ---------------------- |
| 12 |
| 13 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, |
| 15 finds the associated doc comments and builds crosslinked docs from them. |
| 11 | 16 |
| 12 "Doc comments" can be in one of a few forms: | 17 "Doc comments" can be in one of a few forms: |
| 13 | 18 |
| 14 /** | 19 /** |
| 15 * JavaDoc style block comments. | 20 * JavaDoc style block comments. |
| 16 */ | 21 */ |
| 17 | 22 |
| 18 /** Which can also be single line. */ | 23 /** Which can also be single line. */ |
| 19 | 24 |
| 20 /// Triple-slash line comments. | 25 /// Triple-slash line comments. |
| (...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 63 | 68 |
| 64 There is also an extension to markdown specific to dartdoc: A name inside | 69 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 | 70 square brackets that is not a markdown link (i.e. doesn't have square brackets |
| 66 or parentheses following it) like: | 71 or parentheses following it) like: |
| 67 | 72 |
| 68 Calls [someMethod], passing in [arg]. | 73 Calls [someMethod], passing in [arg]. |
| 69 | 74 |
| 70 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 |
| 71 member where that comment appears. Dartdoc will automatically figure out what | 76 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. | 77 the name refers to and generate an approriate link to that member or type. |
| OLD | NEW |