Packages

package comment

Content Hierarchy
Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed abstract class Block extends AnyRef

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

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

    A body of text.

    A body of text. A comment has a single body, which is composed of at least one block. Inside every body is exactly one summary.

    See also

    Summary

  3. final case class Bold(text: Inline) extends Inline with Product with Serializable
  4. final case class Cell(blocks: Seq[Block]) extends Product with Serializable
  5. final case class Chain(items: Seq[Inline]) extends Inline with Product with Serializable
  6. final case class Code(data: String) extends Block with Product with Serializable
  7. final case class ColumnOption(option: Char) extends Product with Serializable
  8. abstract class Comment extends AnyRef

    A Scaladoc comment and all its tags.

    A Scaladoc comment and all its tags.

    Note: the only instantiation site of this class is in model.CommentFactory.

  9. final case class DefinitionList(items: SortedMap[Inline, Block]) extends Block with Product with Serializable
  10. abstract class EntityLink extends Inline
  11. final case class HorizontalRule() extends Block with Product with Serializable
  12. final case class HtmlTag(data: String) extends Inline with Product with Serializable
  13. sealed abstract class Inline extends AnyRef

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

  14. final case class Italic(text: Inline) extends Inline with Product with Serializable
  15. final case class Link(target: String, title: Inline) extends Inline with Product with Serializable
  16. final case class Monospace(text: Inline) extends Inline with Product with Serializable
  17. final case class OrderedList(items: Seq[Block], style: String) extends Block with Product with Serializable
  18. final case class Paragraph(text: Inline) extends Block with Product with Serializable
  19. final case class Row(cells: Seq[Cell]) extends Product with Serializable
  20. final case class Subscript(text: Inline) extends Inline with Product with Serializable
  21. final case class Summary(text: Inline) extends Inline with Product with Serializable

    The summary of a comment, usually its first sentence.

    The summary of a comment, usually its first sentence. There must be exactly one summary per body.

  22. final case class Superscript(text: Inline) extends Inline with Product with Serializable
  23. final case class Table(header: Row, columnOptions: Seq[ColumnOption], rows: Seq[Row]) extends Block with Product with Serializable
  24. final case class Text(text: String) extends Inline with Product with Serializable
  25. final case class Title(text: Inline, level: Int) extends Block with Product with Serializable
  26. final case class Underline(text: Inline) extends Inline with Product with Serializable
  27. final case class UnorderedList(items: Seq[Block]) extends Block with Product with Serializable

Value Members

  1. object ColumnOption extends java.io.Serializable
  2. object EntityLink
  3. object HtmlTag extends java.io.Serializable

Ungrouped