Object/Class

scala.meta.internal.Scaladoc

TagType

Related Docs: class TagType | package Scaladoc

Permalink

object TagType

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TagType
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Base = TagType

    Permalink
  2. final case class UnknownTag(tag: String) extends Base with Product with Serializable

    Permalink

    Represents an unknown tag

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 Author extends Base with Product with Serializable

    Permalink

    Provide author information for the following entity

  5. object Ctor extends Base with Product with Serializable

    Permalink

    Placed in the class comment will describe the primary constructor

  6. object Define extends Base with Product with Serializable

    Permalink

    Allows use of

    Allows use of

    label

    in other Scaladoc comments within the same source file which will be expanded to the contents of

    definition

    .

    definition }}}

    label }}} be expanded to the contents of

    definition

    .

    definition }}}

  7. object Deprecated extends Base with Product with Serializable

    Permalink

    Marks an entity as deprecated, describing replacement implementation

  8. object Documentable extends Base with Product with Serializable

    Permalink

    Expand a type alias and abstract type into a full template page

  9. object Example extends Base with Product with Serializable

    Permalink

    Provide example code and related descriptions.

  10. object Group extends Base with Product with Serializable

    Permalink

    Mark the entity as member of a group

  11. object GroupDesc extends Base with Product with Serializable

    Permalink

    Add optional descriptive text to display under the group name

  12. object GroupName extends Base with Product with Serializable

    Permalink

    Provide an optional name for the group

  13. object GroupPriority extends Base with Product with Serializable

    Permalink

    Control the order of the group on the page

  14. object InheritDoc extends Base with Product with Serializable

    Permalink

    Take comments from a superclass as defaults if comments are not provided locally

  15. object Migration extends Base with Product with Serializable

    Permalink

    Like Deprecated but provides advanced warning of planned changes ahead of deprecation.

  16. object Note extends Base with Product with Serializable

    Permalink

    Add a note for pre or post conditions, or any other notable restrictions or expectations

  17. object Param extends Base with Product with Serializable

    Permalink

    Detail a value parameter for a method or constructor

  18. object Return extends Base with Product with Serializable

    Permalink

    Detail the return value from a method

  19. object See extends Base with Product with Serializable

    Permalink

    Reference other sources of information like external document links or related entities in the documentation

  20. object Since extends Base with Product with Serializable

    Permalink

    The version of the system or API that this entity was first defined in

  21. object Throws extends Base with Product with Serializable

    Permalink

    What exceptions (if any) the method or constructor may throw

  22. object Todo extends Base with Product with Serializable

    Permalink

    Documents unimplemented features in an entity

  23. object TypeParam extends Base with Product with Serializable

    Permalink

    Detail a type parameter for a method, constructor or class

  24. object UseCase extends Base with Product with Serializable

    Permalink

    Provide a simplified method definition for when the full method definition is too complex or noisy

  25. object Version extends Base with Product with Serializable

    Permalink

    The version of the system or API that this entity is a part of

  26. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  27. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  29. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  30. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  32. def getTag(tag: String): TagType

    Permalink
  33. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  35. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  38. val predefined: Seq[Base]

    Permalink

    Contains all known tags

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

    Permalink
    Definition Classes
    AnyRef
  40. val tagTypeMap: Map[String, Base]

    Permalink
  41. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  42. final def wait(): Unit

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped