Type Members

1.  final case class CodeBlock(code: Seq[String]) extends Term with Product with Serializable

   A block of one or more lines of code

2.  final case class CodeExpr(code: String, punct: String = "") extends TextPart with Product with Serializable

   A single embedded code expression

3.  final case class EnclosedJavaTag(tag: String, desc: Seq[String] = Nil) extends TextPart with Product with Serializable

   Represents an enclosed tagged documentation remark

4.  final case class Heading(level: Int, title: String) extends Term with Product with Serializable

   A heading

5.  final case class Link(ref: String, anchor: Seq[String], punct: String = "") extends TextPart with Product with Serializable

   A reference to a symbol

6.  final case class ListBlock(listType: ListType, items: Seq[ListItem]) extends Term with Product with Serializable

   Represents a list block

7.  final case class ListItem(prefix: String, text: Text, terms: Seq[Term] = Nil) extends Product with Serializable

   Represents a list item

8.  sealed abstract class ListType extends AnyRef
9.  final case class MdCodeBlock(info: Seq[String], code: Seq[String], fence: String) extends Term with Product with Serializable

   A markdown block of one or more lines of code

10.  final case class MdCodeSpan(code: String, fence: String, punct: String = "") extends TextPart with Product with Serializable

    A markdown code span, an embedded code expression

11.  final case class Paragraph(terms: Seq[Term]) extends Product with Serializable

    A single paragraph of the document

12.  final case class Table(header: Row, align: Seq[Align], rows: Seq[Row]) extends Term with Product with Serializable

    A table https://www.scala-lang.org/blog/2018/10/04/scaladoc-tables.html

13.  final case class Tag(tag: TagType, label: Option[Word] = None, desc: Seq[Term] = Nil) extends Term with Product with Serializable

    Represents a tagged documentation remark

    Represents a tagged documentation remark

    label

    set iff tag.hasLabel

    desc

    set iff tag.hasDesc

    Note

    if label is expected but desc is not, label will contain the entire tag line

14.  sealed abstract class TagType extends AnyRef
15.  sealed abstract class Term extends AnyRef
16.  final case class Text(parts: Seq[TextPart]) extends Term with Product with Serializable

    A description or other inline text block

17.  trait TextPart extends AnyRef

    An inline part of a text block

18.  final case class Word(value: String) extends TextPart with Product with Serializable

    A single word, without whitespace