Packages

object Scaladoc extends Serializable

The available tokens and their documentation are obtained from:

See also

http://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html

Linear Supertypes
Serializable, java.io.Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Scaladoc
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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) 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]) 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) 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[TextPartInfo]) 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. case class TextPartInfo(part: TextPart, attachedToPrevious: Boolean = false) extends Product with Serializable
  19. final case class Word(value: String) extends TextPart with Product with Serializable

    A single word, without whitespace

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. implicit def iterTextPartToTextPartInfo(parts: Iterable[TextPart]): Iterable[TextPartInfo]
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. implicit def seqTextPartToTextPartInfo(parts: Seq[TextPart]): Seq[TextPartInfo]
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. implicit def textPartToTextPartInfo(part: TextPart): TextPartInfo
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  23. object ListType
  24. object Table extends Serializable
  25. object TagType

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped