4
4
5
5
Use ` dartdoc ` to generate HTML documentaton for your Dart package.
6
6
7
- If you want to _ contribute_ to the dartdoc project, see the
8
- [ contributor docs] [ ] . This page contains information about _ using_ the dartdoc
9
- tool.
7
+ For informtion about contributing to the dartdoc project, see the [ contributor docs] [ ] .
10
8
11
9
## Installing dartdoc
12
10
13
11
### From the Dart SDK
14
12
15
- [ Download the Dart SDK] ( https://www.dartlang.org/downloads/ ) , version
16
- 1.12-dev.5.10 or later. If not already added, add the SDK's ` bin ` directory to
17
- your ` PATH ` .
13
+ [ Download the Dart SDK] ( https://www.dartlang.org/downloads/ ) ; if not already added,
14
+ add the SDK's ` bin ` directory to your ` PATH ` .
18
15
19
16
### From pub.dartlang.org
20
17
@@ -28,7 +25,7 @@ to the Dart SDK.
28
25
29
26
## Generating docs
30
27
31
- Run ` dartdoc ` from the root directory of package. For example:
28
+ Run ` dartdoc ` from the root directory of package. For example:
32
29
33
30
```
34
31
$ dartdoc
@@ -96,18 +93,13 @@ File names are _case-sensitive_.
96
93
Check out the
97
94
[ Effective Dart: Documentation guide] ( https://www.dartlang.org/effective-dart/documentation/ ) .
98
95
99
- The guide covers formatting, linking, markup, and general best practices
100
- when authoring doc comments for Dart with dartdoc.
96
+ The guide covers formatting, linking, markup, and general best practices when
97
+ authoring doc comments for Dart with ` dartdoc ` .
101
98
102
99
### Excluding from documentation
103
100
104
- dartdoc will not generate documentation for a Dart element and its children that has
105
- the ` <nodoc> ` tag in the documentation comment.
106
-
107
- ## Older versions
108
-
109
- As of Dart 1.12, ` dartdoc ` is shipped with the Dart SDK and replaces the
110
- older ` docgen ` tool.
101
+ ` dartdoc ` will not generate documentation for a Dart element and its children that
102
+ has the ` <nodoc> ` tag in the documentation comment.
111
103
112
104
## Issues and bugs
113
105
0 commit comments