OLD | NEW |
1 // Copyright (c) 2013, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2013, the Dart project authors. Please see the AUTHORS file |
2 // for details. All rights reserved. Use of this source code is governed by a | 2 // for details. All rights reserved. Use of this source code is governed by a |
3 // BSD-style license that can be found in the LICENSE file. | 3 // BSD-style license that can be found in the LICENSE file. |
4 | 4 |
5 /** | 5 /** |
6 * To generate docs for a library, run this script with the path to an | 6 * To generate docs for a library, run this script with the path to an |
7 * entrypoint .dart file, like: | 7 * entrypoint .dart file, like: |
8 * | 8 * |
9 * $ dart dartdoc.dart foo.dart | 9 * $ dart dartdoc.dart foo.dart |
10 * | 10 * |
11 * This will create a "docs" directory with the docs for your libraries. To | 11 * This will create a "docs" directory with the docs for your libraries. To |
12 * create these beautiful docs, dartdoc parses your library and every library | 12 * create these beautiful docs, dartdoc parses your library and every library |
13 * it imports (recursively). From each library, it parses all classes and | 13 * it imports (recursively). From each library, it parses all classes and |
14 * members, finds the associated doc comments and builds crosslinked docs from | 14 * members, finds the associated doc comments and builds crosslinked docs from |
15 * them. | 15 * them. |
16 */ | 16 */ |
17 library dartdoc; | 17 library dartdoc; |
18 | 18 |
19 import 'dart:async'; | 19 import 'dart:async'; |
20 import 'dart:io'; | 20 import 'dart:io'; |
21 import 'dart:isolate'; | 21 import 'dart:isolate'; |
22 import 'dart:json' as json; | 22 import 'dart:json' as json; |
23 import 'dart:math'; | 23 import 'dart:math'; |
24 | 24 |
25 import 'package:pathos/path.dart' as pathos; | 25 import 'package:path/path.dart' as pathos; |
26 | 26 |
27 import 'classify.dart'; | 27 import 'classify.dart'; |
28 import 'markdown.dart' as md; | 28 import 'markdown.dart' as md; |
29 import 'universe_serializer.dart'; | 29 import 'universe_serializer.dart'; |
30 | 30 |
31 import 'src/dartdoc/nav.dart'; | 31 import 'src/dartdoc/nav.dart'; |
32 import 'src/dartdoc/utils.dart'; | 32 import 'src/dartdoc/utils.dart'; |
33 import 'src/export_map.dart'; | 33 import 'src/export_map.dart'; |
34 import 'src/json_serializer.dart' as json_serializer; | 34 import 'src/json_serializer.dart' as json_serializer; |
35 | 35 |
(...skipping 2271 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2307 return ''' | 2307 return ''' |
2308 <div class="mdn"> | 2308 <div class="mdn"> |
2309 $mdnComment | 2309 $mdnComment |
2310 <div class="mdn-note"><a href="$mdnUrl">from MDN</a></div> | 2310 <div class="mdn-note"><a href="$mdnUrl">from MDN</a></div> |
2311 </div> | 2311 </div> |
2312 '''; | 2312 '''; |
2313 } | 2313 } |
2314 | 2314 |
2315 String toString() => mdnComment; | 2315 String toString() => mdnComment; |
2316 } | 2316 } |
OLD | NEW |