Packages

class Doclet extends Generator with Universer

The default doclet used by the scaladoc command line tool when no user-provided doclet is provided.

Source
Doclet.scala
Linear Supertypes
Universer, Generator, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Doclet
  2. Universer
  3. Generator
  4. AnyRef
  5. 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 Doclet(reporter: Reporter)
  2. new Doclet()
    Annotations
    @deprecated
    Deprecated

    (Since version 2.12.0) Doclets should be created with the Reporter constructor. Otherwise logging reporters will not be shared by the creating parent

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Doclet to any2stringadd[Doclet] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Doclet, B)
    Implicit
    This member is added by an implicit conversion from Doclet to ArrowAssoc[Doclet] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. 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
    Definition Classes
    Generator
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. def ensuring(cond: (Doclet) ⇒ Boolean, msg: ⇒ Any): Doclet
    Implicit
    This member is added by an implicit conversion from Doclet to Ensuring[Doclet] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (Doclet) ⇒ Boolean): Doclet
    Implicit
    This member is added by an implicit conversion from Doclet to Ensuring[Doclet] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): Doclet
    Implicit
    This member is added by an implicit conversion from Doclet to Ensuring[Doclet] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): Doclet
    Implicit
    This member is added by an implicit conversion from Doclet to Ensuring[Doclet] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def generate(): Unit

    Outputs documentation (as a side effect).

    Outputs documentation (as a side effect).

    Definition Classes
    Generator
  17. def generateImpl(): Unit

    Outputs documentation (as a side effect).

    Outputs documentation (as a side effect). This method is called only if all checks are true.

    Definition Classes
    Doclet → Generator
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def setUniverse(u: Universe): Unit
    Definition Classes
    Universer
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. def universe: Universe
    Definition Classes
    Universer
  28. val universeField: Universe
    Attributes
    protected
    Definition Classes
    Universer
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  32. def →[B](y: B): (Doclet, B)
    Implicit
    This member is added by an implicit conversion from Doclet to ArrowAssoc[Doclet] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Doclet to StringFormat[Doclet] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

Inherited from Universer

Inherited from Generator

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped