Dart API Reference › dartdoc › DocComment

args

dart:core

dart:coreimpl

dart:crypto

dart:io

dart:isolate

dart:json

dart:math

dart:mirrors

dart:scalarlist

dart:uri

dart:utf

dartdoc

fixnum

htmlescape

intl

logging

meta

unittest

webdriver

DocComment class 

class DocComment {
  final String text;

  /**
   * Non-null if the comment is inherited from another declaration.
   */
  final InterfaceMirror inheritedFrom;

  DocComment(this.text, [this.inheritedFrom = null]) {
    assert(text != null && !text.trim().isEmpty());
  }

  String get html => md.markdownToHtml(text);

  String toString() => text;
}

Constructors

new DocComment(String text, [InterfaceMirror inheritedFrom = null]) #

DocComment(this.text, [this.inheritedFrom = null]) {
  assert(text != null && !text.trim().isEmpty());
}

Properties

final String html # 

String get html => md.markdownToHtml(text);

final InterfaceMirror inheritedFrom #

Non-null if the comment is inherited from another declaration.

final InterfaceMirror inheritedFrom;

final String text # 

final String text;

Methods

String toString() #

Returns a string representation of this object.

docs inherited from Object 
String toString() => text;
This page was generated at 2012-10-23 18:58:54.253

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the BSD License.

Comments that are not specifically about the API libraries will be moderated and possibly deleted. Because we may incorporate information from comments into the documentation, any comment submitted here is under the same license as the documentation.

Terms of Service | Privacy Policy