scala.tools.nsc.doc.model

comment

package comment

Visibility
  1. Public
  2. All

Type Members

  1. class Block extends AnyRef

    A block-level element of text, such as a paragraph or code block.

  2. case class Body (blocks: Seq[Block]) extends Product with Serializable

    A body of text.

  3. case class Bold (text: Inline) extends Inline with Product with Serializable

    Attributes
    final

  4. case class Chain (items: Seq[Inline]) extends Inline with Product with Serializable

    Attributes
    final

  5. case class Code (data: String) extends Block with Product with Serializable

    Attributes
    final

  6. class Comment extends AnyRef

    A Scaladoc comment and all its tags.

  7. trait CommentFactory extends AnyRef

    The comment parser transforms raw comment strings into Comment objects.

  8. case class DefinitionList (items: SortedMap[Inline, Block]) extends Block with Product with Serializable

    Attributes
    final

  9. case class EntityLink (target: TemplateEntity) extends Inline with Product with Serializable

    Attributes
    final

  10. case class HorizontalRule () extends Block with Product with Serializable

    Attributes
    final

  11. case class HtmlTag (data: String) extends Inline with Product with Serializable

    Attributes
    final

  12. class Inline extends AnyRef

    An section of text inside a block, possibly with formatting.

  13. case class Italic (text: Inline) extends Inline with Product with Serializable

    Attributes
    final

  14. case class Link (target: String, title: Inline) extends Inline with Product with Serializable

    Attributes
    final

  15. case class Monospace (text: String) extends Inline with Product with Serializable

    Attributes
    final

  16. case class OrderedList (items: Seq[Block], style: String) extends Block with Product with Serializable

    Attributes
    final

  17. case class Paragraph (text: Inline) extends Block with Product with Serializable

    Attributes
    final

  18. case class Subscript (text: Inline) extends Inline with Product with Serializable

    Attributes
    final

  19. case class Summary (text: Inline) extends Inline with Product with Serializable

    The summary of a comment, usually its first sentence.

  20. case class Superscript (text: Inline) extends Inline with Product with Serializable

    Attributes
    final

  21. case class Text (text: String) extends Inline with Product with Serializable

    Attributes
    final

  22. case class Title (text: Inline, level: Int) extends Block with Product with Serializable

    Attributes
    final

  23. case class Underline (text: Inline) extends Inline with Product with Serializable

    Attributes
    final

  24. case class UnorderedList (items: Seq[Block]) extends Block with Product with Serializable

    Attributes
    final