44
55Use ` dartdoc ` to generate HTML documentaton for your Dart package.
66
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] [ ] .
108
119## Installing dartdoc
1210
1311### From the Dart SDK
1412
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 ` .
1815
1916### From pub.dartlang.org
2017
@@ -28,7 +25,7 @@ to the Dart SDK.
2825
2926## Generating docs
3027
31- Run ` dartdoc ` from the root directory of package. For example:
28+ Run ` dartdoc ` from the root directory of package. For example:
3229
3330```
3431$ dartdoc
@@ -96,18 +93,13 @@ File names are _case-sensitive_.
9693Check out the
9794[ Effective Dart: Documentation guide] ( https://www.dartlang.org/effective-dart/documentation/ ) .
9895
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 ` .
10198
10299### Excluding from documentation
103100
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.
111103
112104## Issues and bugs
113105
0 commit comments