Packages

object Scaladoc extends java.io.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
java.io.Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Scaladoc
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 Heading(level: Int, title: String) extends Term with Product with Serializable

    A heading

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

    A reference to a symbol

  5. final case class ListBlock(prefix: String, item: Seq[ListItem]) extends Term with Product with Serializable

    Represents a list block

  6. final case class ListItem(text: Text, nested: Option[ListBlock] = None) extends Product with Serializable

    Represents a list item

  7. final case class Paragraph(term: Seq[Term]) extends Product with Serializable

    A single paragraph of the document

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

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

  9. final case class Tag(tag: TagType, label: Word = null, desc: Text = null) 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

  10. sealed abstract class TagType extends AnyRef
  11. sealed abstract class Term extends AnyRef
  12. final case class Text(part: Seq[TextPart]) extends Term with Product with Serializable

    A description or other inline text block

  13. trait TextPart extends AnyRef

    An inline part of a text block

  14. 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(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): 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[_ <: AnyRef]
    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. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. object Table extends java.io.Serializable
  21. object TagType

Inherited from java.io.Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped