scala.tools.nsc.doc.html

Doclet

class Doclet extends Generator with Universer with Indexer

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

Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Doclet
  2. Indexer
  3. Universer
  4. Generator
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Doclet()

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Doclet to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Doclet, B)

    Implicit information
    This member is added by an implicit conversion from Doclet to ArrowAssoc[Doclet] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. 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
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def ensuring(cond: (Doclet) ⇒ Boolean, msg: ⇒ Any): Doclet

    Implicit information
    This member is added by an implicit conversion from Doclet to Ensuring[Doclet] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Doclet) ⇒ Boolean): Doclet

    Implicit information
    This member is added by an implicit conversion from Doclet to Ensuring[Doclet] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): Doclet

    Implicit information
    This member is added by an implicit conversion from Doclet to Ensuring[Doclet] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Doclet

    Implicit information
    This member is added by an implicit conversion from Doclet to Ensuring[Doclet] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Doclet to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. def generate(): Unit

    Outputs documentation (as a side effect).

    Outputs documentation (as a side effect).

    Definition Classes
    Generator
  20. 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
    DocletGenerator
  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  22. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  23. def index: Index

    Definition Classes
    Indexer
  24. var indexField: Index

    Attributes
    protected
    Definition Classes
    Indexer
  25. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  29. def setIndex(i: Index): Unit

    Definition Classes
    Indexer
  30. def setUniverse(u: Universe): Unit

    Definition Classes
    Universer
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  32. def toString(): String

    Definition Classes
    AnyRef → Any
  33. def universe: Universe

    Definition Classes
    Universer
  34. var universeField: Universe

    Attributes
    protected
    Definition Classes
    Universer
  35. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. def [B](y: B): (Doclet, B)

    Implicit information
    This member is added by an implicit conversion from Doclet to ArrowAssoc[Doclet] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Doclet to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (doclet: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Doclet to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (doclet: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Doclet

    Implicit information
    This member is added by an implicit conversion from Doclet to ArrowAssoc[Doclet] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (doclet: ArrowAssoc[Doclet]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Doclet

    Implicit information
    This member is added by an implicit conversion from Doclet to Ensuring[Doclet] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (doclet: Ensuring[Doclet]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Indexer

Inherited from Universer

Inherited from Generator

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Doclet to StringAdd

Inherited by implicit conversion any2stringfmt from Doclet to StringFormat

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

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

Ungrouped