object Scaladoc extends Serializable
The available tokens and their documentation are obtained from:
- See also
http://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- Scaladoc
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Type Members
-
final
case class
CodeBlock(code: Seq[String]) extends Term with Product with Serializable
A block of one or more lines of code
-
final
case class
CodeExpr(code: String, punct: String) extends TextPart with Product with Serializable
A single embedded code expression
-
final
case class
Heading(level: Int, title: String) extends Term with Product with Serializable
A heading
-
final
case class
Link(ref: String, anchor: Seq[String], punct: String) extends TextPart with Product with Serializable
A reference to a symbol
-
final
case class
ListBlock(prefix: String, item: Seq[ListItem]) extends Term with Product with Serializable
Represents a list block
-
final
case class
ListItem(text: Text, nested: Option[ListBlock] = None) extends Product with Serializable
Represents a list item
-
final
case class
Paragraph(term: Seq[Term]) extends Product with Serializable
A single paragraph of the document
-
final
case class
Table(header: Row, align: Seq[Align], row: Seq[Row]) extends Term with Product with Serializable
A table https://www.scala-lang.org/blog/2018/10/04/scaladoc-tables.html
-
final
case class
Tag(tag: TagType, label: Word = null, desc: Text = null) extends Term with Product with Serializable
Represents a tagged documentation remark
Represents a tagged documentation remark
- label
set iff
tag.hasLabel
- desc
set iff
tag.hasDesc
- sealed abstract class TagType extends AnyRef
- sealed abstract class Term extends AnyRef
-
final
case class
Text(part: Seq[TextPart]) extends Term with Product with Serializable
A description or other inline text block
-
trait
TextPart extends AnyRef
An inline part of a text block
-
final
case class
Word(value: String) extends TextPart with Product with Serializable
A single word, without whitespace
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
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()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
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 Table extends Serializable
- object TagType