case class DocToken(kind: Kind, name: Option[String], body: Option[String]) extends Product with Serializable
Represents a scaladoc line.
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- DocToken
- Serializable
- Product
- Equals
- AnyRef
- Any
Implicitly
- by XtensionExtractors
- by ExtensionReplacers
- by XtensionTokenizeInputLike
- by XtensionShow
- by XtensionParseInputLike
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (DocToken, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val body: Option[String]
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (DocToken) => Boolean, msg: => Any): DocToken
- def ensuring(cond: (DocToken) => Boolean): DocToken
- def ensuring(cond: Boolean, msg: => Any): DocToken
- def ensuring(cond: Boolean): DocToken
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def extract[B](implicit ev: Extract[DocToken, B]): List[B]
- Implicit
- This member is added by an implicit conversion from DocToken tocontrib.XtensionExtractors[DocToken] performed by method XtensionExtractors in scala.meta.contrib.implicits.ExtractExtensions.
- Definition Classes
- XtensionExtractors
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hasMod(mod: Mod)(implicit ev: Extract[DocToken, Mod]): Boolean
- Implicit
- This member is added by an implicit conversion from DocToken tocontrib.XtensionExtractors[DocToken] performed by method XtensionExtractors in scala.meta.contrib.implicits.ExtractExtensions.
- Definition Classes
- XtensionExtractors
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val kind: Kind
- val name: Option[String]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def parse[U](implicit convert: Convert[DocToken, inputs.Input], parse: Parse[U], dialect: Dialect): parsers.Parsed[U]
- Implicit
- This member is added by an implicit conversion from DocToken tometa.XtensionParseInputLike[DocToken] performed by method XtensionParseInputLike in scala.meta.parsers.Api.
- Definition Classes
- XtensionParseInputLike
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def references: List[Reference]
Obtains all the code references from this DocToken.
- def show[Style[X] <: Show[X]](implicit style: Style[DocToken]): String
- Implicit
- This member is added by an implicit conversion from DocToken tometa.XtensionShow[DocToken] performed by method XtensionShow in scala.meta.prettyprinters.Api.
- Definition Classes
- XtensionShow
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- DocToken → AnyRef → Any
- def tokenize(implicit convert: Convert[DocToken, inputs.Input], tokenize: Tokenize, dialect: Dialect): tokenizers.Tokenized
- Implicit
- This member is added by an implicit conversion from DocToken tometa.XtensionTokenizeInputLike[DocToken] performed by method XtensionTokenizeInputLike in scala.meta.tokenizers.Api.
- Definition Classes
- XtensionTokenizeInputLike
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withMods(bs: List[Mod])(implicit ev: Replace[DocToken, Mod]): DocToken
- Implicit
- This member is added by an implicit conversion from DocToken tocontrib.ExtensionReplacers[DocToken] performed by method ExtensionReplacers in scala.meta.contrib.implicits.ReplaceExtensions.
- Definition Classes
- ExtensionReplacers
- def withStats(bs: List[Stat])(implicit ev: Replace[DocToken, Stat]): DocToken
- Implicit
- This member is added by an implicit conversion from DocToken tocontrib.ExtensionReplacers[DocToken] performed by method ExtensionReplacers in scala.meta.contrib.implicits.ReplaceExtensions.
- Definition Classes
- ExtensionReplacers
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from DocToken toStringFormat[DocToken] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (DocToken, B)
- Implicit
- This member is added by an implicit conversion from DocToken toArrowAssoc[DocToken] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.