abstract class Generator extends AnyRef
Custom Scaladoc generators must implement the Generator class. A custom generator can be selected in Scaladoc
using the -doc-generator command line option.
The Generator class does not provide data about the documented code. A number of data provider traits can be used
to configure what data is actually available to the generator:
- A
Universerprovides aUniversedata structure representing the interfaces and comments of the documented program. To implement this class only requires defining methodgenerateImpl.
- Source
- Generator.scala
- Alphabetic
- By Inheritance
- Generator
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Generator()
Abstract Value Members
- abstract def generateImpl(): Unit
Outputs documentation (as a side effect).
Outputs documentation (as a side effect). This method is called only if all
checksare true.- Attributes
- protected
Concrete 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): (Generator, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val checks: Set[() => Boolean]
A series of tests that must be true before generation can be done.
A series of tests that must be true before generation can be done. This is used by data provider traits to confirm that they have been correctly initialised before allowing generation to proceed.
- Attributes
- protected
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (Generator) => Boolean, msg: => Any): Generator
- def ensuring(cond: (Generator) => Boolean): Generator
- def ensuring(cond: Boolean, msg: => Any): Generator
- def ensuring(cond: Boolean): Generator
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- def generate(): Unit
Outputs documentation (as a side effect).
- final def getClass(): Class[_ <: AnyRef]
- 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(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()
Deprecated Value Members
- def →[B](y: B): (Generator, B)
- Implicit
- This member is added by an implicit conversion from Generator toArrowAssoc[Generator] 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.
The Scala compiler and reflection APIs.