object TagType
- Alphabetic
- By Inheritance
- TagType
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- type Base = TagType
-
final
case class
UnknownTag(tag: String) extends Base with Product with Serializable
Represents an unknown tag
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getTag(tag: String): TagType
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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()
-
val
predefined: Seq[Base]
Contains all known tags
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val tagTypeMap: Map[String, Base]
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
object
Author extends Base with Product with Serializable
Provide author information for the following entity
-
object
Ctor extends Base with Product with Serializable
Placed in the class comment will describe the primary constructor
-
object
Define extends Base with Product with Serializable
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 }}}
-
object
Deprecated extends Base with Product with Serializable
Marks an entity as deprecated, describing replacement implementation
-
object
Documentable extends Base with Product with Serializable
Expand a type alias and abstract type into a full template page
-
object
Example extends Base with Product with Serializable
Provide example code and related descriptions.
-
object
Group extends Base with Product with Serializable
Mark the entity as member of a group
-
object
GroupDesc extends Base with Product with Serializable
Add optional descriptive text to display under the group name
-
object
GroupName extends Base with Product with Serializable
Provide an optional name for the group
-
object
GroupPriority extends Base with Product with Serializable
Control the order of the group on the page
-
object
InheritDoc extends Base with Product with Serializable
Take comments from a superclass as defaults if comments are not provided locally
-
object
Migration extends Base with Product with Serializable
Like Deprecated but provides advanced warning of planned changes ahead of deprecation.
-
object
Note extends Base with Product with Serializable
Add a note for pre or post conditions, or any other notable restrictions or expectations
-
object
Param extends Base with Product with Serializable
Detail a value parameter for a method or constructor
-
object
Return extends Base with Product with Serializable
Detail the return value from a method
-
object
See extends Base with Product with Serializable
Reference other sources of information like external document links or related entities in the documentation
-
object
Since extends Base with Product with Serializable
The version of the system or API that this entity was first defined in
-
object
Throws extends Base with Product with Serializable
What exceptions (if any) the method or constructor may throw
-
object
Todo extends Base with Product with Serializable
Documents unimplemented features in an entity
-
object
TypeParam extends Base with Product with Serializable
Detail a type parameter for a method, constructor or class
-
object
UseCase extends Base with Product with Serializable
Provide a simplified method definition for when the full method definition is too complex or noisy
-
object
Version extends Base with Product with Serializable
The version of the system or API that this entity is a part of