package comment
Ordering
- Alphabetic
Visibility
- Public
- All
Type Members
-
sealed abstract
class
Block extends AnyRef
A block-level element of text, such as a paragraph or code block.
-
final
case class
Body(blocks: collection.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
- final case class Bold(text: Inline) extends Inline with Product with Serializable
- final case class Cell(blocks: collection.Seq[Block]) extends Product with Serializable
- final case class Chain(items: collection.Seq[Inline]) extends Inline with Product with Serializable
- final case class Code(data: String) extends Block with Product with Serializable
- final case class ColumnOption(option: Char) extends Product with Serializable
-
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.
- final case class DefinitionList(items: SortedMap[Inline, Block]) extends Block with Product with Serializable
- abstract class EntityLink extends Inline
- final case class HorizontalRule() extends Block with Product with Serializable
- final case class HtmlTag(data: String) extends Inline with Product with Serializable
-
sealed abstract
class
Inline extends AnyRef
An section of text inside a block, possibly with formatting.
- final case class Italic(text: Inline) extends Inline with Product with Serializable
- final case class Link(target: String, title: Inline) extends Inline with Product with Serializable
- final case class Monospace(text: Inline) extends Inline with Product with Serializable
- final case class OrderedList(items: collection.Seq[Block], style: String) extends Block with Product with Serializable
- final case class Paragraph(text: Inline) extends Block with Product with Serializable
- final case class Row(cells: collection.Seq[Cell]) extends Product with Serializable
- final case class Subscript(text: Inline) extends Inline with Product with Serializable
-
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.
- final case class Superscript(text: Inline) extends Inline with Product with Serializable
- final case class Table(header: Row, columnOptions: collection.Seq[ColumnOption], rows: collection.Seq[Row]) extends Block with Product with Serializable
- final case class Text(text: String) extends Inline with Product with Serializable
- final case class Title(text: Inline, level: Int) extends Block with Product with Serializable
- final case class Underline(text: Inline) extends Inline with Product with Serializable
- final case class UnorderedList(items: collection.Seq[Block]) extends Block with Product with Serializable
Value Members
- object ColumnOption extends Serializable
- object EntityLink
- object HtmlTag extends Serializable
The Scala compiler and reflection APIs.