Class/Object

scala.meta.contrib

DocToken

Related Docs: object DocToken | package contrib

Permalink

case class DocToken(kind: Kind, name: Option[String], body: Option[String]) extends Product with Serializable

Represents a scaladoc line.

Linear Supertypes
Serializable, java.io.Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocToken
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by XtensionShow
  2. by XtensionExtractors
  3. by XtensionTokenizeInputLike
  4. by XtensionParseInputLike
  5. by any2stringadd
  6. by StringFormat
  7. by Ensuring
  8. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DocToken(kind: Kind, name: Option[String], body: Option[String])

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from DocToken to any2stringadd[DocToken] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DocToken, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from DocToken to ArrowAssoc[DocToken] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. val body: Option[String]

    Permalink
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def ensuring(cond: (DocToken) ⇒ Boolean, msg: ⇒ Any): DocToken

    Permalink
    Implicit information
    This member is added by an implicit conversion from DocToken to Ensuring[DocToken] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (DocToken) ⇒ Boolean): DocToken

    Permalink
    Implicit information
    This member is added by an implicit conversion from DocToken to Ensuring[DocToken] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): DocToken

    Permalink
    Implicit information
    This member is added by an implicit conversion from DocToken to Ensuring[DocToken] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): DocToken

    Permalink
    Implicit information
    This member is added by an implicit conversion from DocToken to Ensuring[DocToken] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def extract[B](implicit ev: Extract[DocToken, B]): collection.immutable.Seq[B]

    Permalink
    Implicit information
    This member is added by an implicit conversion from DocToken to contrib.XtensionExtractors[DocToken] performed by method XtensionExtractors in scala.meta.contrib.implicits.ExtractExtensions.
    Definition Classes
    XtensionExtractors
  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from DocToken to StringFormat[DocToken] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. val kind: Kind

    Permalink
  20. val name: Option[String]

    Permalink
  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. def parse[U](implicit convert: Convert[DocToken, inputs.Input], parse: Parse[U], dialect: Dialect): parsers.Parsed[U]

    Permalink
    Implicit information
    This member is added by an implicit conversion from DocToken to meta.XtensionParseInputLike[DocToken] performed by method XtensionParseInputLike in scala.meta.parsers.Api.
    Definition Classes
    XtensionParseInputLike
  25. def references: Seq[Reference]

    Permalink

    Obtains all the code references from this DocToken.

  26. def show[Style[X] <: Show[X]](implicit style: Style[DocToken]): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from DocToken to meta.XtensionShow[DocToken] performed by method XtensionShow in scala.meta.prettyprinters.Api.
    Definition Classes
    XtensionShow
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def toString(): String

    Permalink
    Definition Classes
    DocToken → AnyRef → Any
  29. def tokenize(implicit convert: Convert[DocToken, inputs.Input], tokenize: Tokenize, dialect: Dialect): tokenizers.Tokenized

    Permalink
    Implicit information
    This member is added by an implicit conversion from DocToken to meta.XtensionTokenizeInputLike[DocToken] performed by method XtensionTokenizeInputLike in scala.meta.tokenizers.Api.
    Definition Classes
    XtensionTokenizeInputLike
  30. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. def [B](y: B): (DocToken, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from DocToken to ArrowAssoc[DocToken] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion XtensionShow from DocToken to meta.XtensionShow[DocToken]

Inherited by implicit conversion XtensionExtractors from DocToken to contrib.XtensionExtractors[DocToken]

Inherited by implicit conversion XtensionTokenizeInputLike from DocToken to meta.XtensionTokenizeInputLike[DocToken]

Inherited by implicit conversion XtensionParseInputLike from DocToken to meta.XtensionParseInputLike[DocToken]

Inherited by implicit conversion any2stringadd from DocToken to any2stringadd[DocToken]

Inherited by implicit conversion StringFormat from DocToken to StringFormat[DocToken]

Inherited by implicit conversion Ensuring from DocToken to Ensuring[DocToken]

Inherited by implicit conversion ArrowAssoc from DocToken to ArrowAssoc[DocToken]

Ungrouped