OLD | NEW |
1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2012, 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 * This generates the reference documentation for the core libraries that come | 6 * This generates the reference documentation for the core libraries that come |
7 * with dart. It is built on top of dartdoc, which is a general-purpose library | 7 * with dart. It is built on top of dartdoc, which is a general-purpose library |
8 * for generating docs from any Dart code. This library extends that to include | 8 * for generating docs from any Dart code. This library extends that to include |
9 * additional information and styling specific to our standard library. | 9 * additional information and styling specific to our standard library. |
10 * | 10 * |
(...skipping 240 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
251 super.docLibraryNavigationJson(library, libraryList); | 251 super.docLibraryNavigationJson(library, libraryList); |
252 } | 252 } |
253 | 253 |
254 void docLibrary(LibraryMirror library) { | 254 void docLibrary(LibraryMirror library) { |
255 // TODO(rnystrom): Hackish. The IO libraries reference this but we don't | 255 // TODO(rnystrom): Hackish. The IO libraries reference this but we don't |
256 // want it in the docs. | 256 // want it in the docs. |
257 if (doc.displayName(library) == 'dart:nativewrappers') return; | 257 if (doc.displayName(library) == 'dart:nativewrappers') return; |
258 super.docLibrary(library); | 258 super.docLibrary(library); |
259 } | 259 } |
260 | 260 |
261 /** Override definition from parent class to strip out annotation tags. */ | |
262 doc.DocComment createDocComment(String text, | |
263 [ClassMirror inheritedFrom]) { | |
264 String strippedText = | |
265 text.replaceAll(new RegExp("@([a-zA-Z]+) ([^;]+)(?:;|\$)"), | |
266 '').trim(); | |
267 if (strippedText.isEmpty) return null; | |
268 return super.createDocComment(strippedText, inheritedFrom); | |
269 } | |
270 | |
271 doc.DocComment getLibraryComment(LibraryMirror library) { | 261 doc.DocComment getLibraryComment(LibraryMirror library) { |
272 return super.getLibraryComment(library); | 262 return super.getLibraryComment(library); |
273 } | 263 } |
274 | 264 |
275 doc.DocComment getTypeComment(TypeMirror type) { | 265 doc.DocComment getTypeComment(TypeMirror type) { |
276 return _mergeDocs( | 266 return _mergeDocs( |
277 includeMdnTypeComment(type), super.getTypeComment(type)); | 267 includeMdnTypeComment(type), super.getTypeComment(type)); |
278 } | 268 } |
279 | 269 |
280 doc.DocComment getMemberComment(MemberMirror member) { | 270 doc.DocComment getMemberComment(MemberMirror member) { |
(...skipping 174 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
455 return ''' | 445 return ''' |
456 <div class="mdn"> | 446 <div class="mdn"> |
457 $mdnComment | 447 $mdnComment |
458 <div class="mdn-note"><a href="$mdnUrl">from MDN</a></div> | 448 <div class="mdn-note"><a href="$mdnUrl">from MDN</a></div> |
459 </div> | 449 </div> |
460 '''; | 450 '''; |
461 } | 451 } |
462 | 452 |
463 String toString() => mdnComment; | 453 String toString() => mdnComment; |
464 } | 454 } |
OLD | NEW |