Class

scala.meta.internal.Scaladoc

Tag

Related Doc: package Scaladoc

Permalink

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

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

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

Instance Constructors

  1. new Tag(tag: TagType, label: Option[Word] = None, desc: Seq[Term] = Nil)

    Permalink

    label

    set iff tag.hasLabel

    desc

    set iff tag.hasDesc

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 Tag to any2stringadd[Tag] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Tag, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Tag to ArrowAssoc[Tag] 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. def clone(): AnyRef

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

  8. val desc: Seq[Term]

    Permalink

    set iff tag.hasDesc

  9. def ensuring(cond: (Tag) ⇒ Boolean, msg: ⇒ Any): Tag

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

  10. def ensuring(cond: (Tag) ⇒ Boolean): Tag

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

  11. def ensuring(cond: Boolean, msg: ⇒ Any): Tag

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

  12. def ensuring(cond: Boolean): Tag

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

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

    Permalink
    Definition Classes
    AnyRef

  14. def finalize(): Unit

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

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Tag to StringFormat[Tag] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  18. val label: Option[Word]

    Permalink

    set iff tag.hasLabel

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

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  23. val tag: TagType

    Permalink

  24. final def wait(): Unit

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

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

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

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

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

  27. def →[B](y: B): (Tag, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Tag to ArrowAssoc[Tag] 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 Term

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped