Object/Class

scala.meta.internal

Scaladoc

Related Docs: class Scaladoc | package internal

Permalink

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

    Permalink

    A block of one or more lines of code

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

    Permalink

    A single embedded code expression

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

    Permalink

    Represents an enclosed tagged documentation remark

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

    Permalink

    A heading

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

    Permalink

    A reference to a symbol

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

    Permalink

    Represents a list block

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

    Permalink

    Represents a list item

  8. final case class MdCodeBlock(info: Seq[String], code: Seq[String], fence: String) extends Term with Product with Serializable

    Permalink

    A markdown block of one or more lines of code

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

    Permalink

    A single paragraph of the document

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

    Permalink

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

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

    Permalink

    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

  12. sealed abstract class TagType extends AnyRef

    Permalink

  13. sealed abstract class Term extends AnyRef

    Permalink

  14. final case class Text(parts: Seq[TextPart]) extends Term with Product with Serializable

    Permalink

    A description or other inline text block

  15. trait TextPart extends AnyRef

    Permalink

    An inline part of a text block

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

    Permalink

    A single word, without whitespace

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. object Table extends Serializable

    Permalink

  5. object TagType

    Permalink

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped