scala.tools.nsc.doc.html

HtmlFactory

class HtmlFactory extends AnyRef

A class that can generate Scaladoc sites to some fixed root folder.

Linear Supertypes
AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HtmlFactory
  2. AnyRef
  3. 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 HtmlFactory(universe: Universe, index: Index)

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 HtmlFactory to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (HtmlFactory, B)

    Implicit information
    This member is added by an implicit conversion from HtmlFactory to ArrowAssoc[HtmlFactory] 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. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. def encoding: String

    The character encoding to be used for generated Scaladoc sites.

    The character encoding to be used for generated Scaladoc sites. This value is currently always UTF-8.

  11. def ensuring(cond: (HtmlFactory) ⇒ Boolean, msg: ⇒ Any): HtmlFactory

    Implicit information
    This member is added by an implicit conversion from HtmlFactory to Ensuring[HtmlFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: (HtmlFactory) ⇒ Boolean): HtmlFactory

    Implicit information
    This member is added by an implicit conversion from HtmlFactory to Ensuring[HtmlFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean, msg: ⇒ Any): HtmlFactory

    Implicit information
    This member is added by an implicit conversion from HtmlFactory to Ensuring[HtmlFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: Boolean): HtmlFactory

    Implicit information
    This member is added by an implicit conversion from HtmlFactory to Ensuring[HtmlFactory] 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 HtmlFactory to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  19. def generate(): Unit

    Generates the Scaladoc site for a model into the site root.

    Generates the Scaladoc site for a model into the site root. A scaladoc site is a set of HTML and related files that document a model extracted from a compiler run.

  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  22. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  23. def libResources: collection.immutable.List[String]

  24. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  25. final def notify(): Unit

    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  27. def siteRoot: File

  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  29. def toString(): String

    Definition Classes
    AnyRef → Any

  30. val universe: Universe

  31. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. def writeTemplates(writeForThis: (HtmlPage) ⇒ Unit): Unit

  35. def →[B](y: B): (HtmlFactory, B)

    Implicit information
    This member is added by an implicit conversion from HtmlFactory to ArrowAssoc[HtmlFactory] 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 HtmlFactory 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:
    (htmlFactory: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from HtmlFactory 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:
    (htmlFactory: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: HtmlFactory

    Implicit information
    This member is added by an implicit conversion from HtmlFactory to ArrowAssoc[HtmlFactory] 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:
    (htmlFactory: ArrowAssoc[HtmlFactory]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: HtmlFactory

    Implicit information
    This member is added by an implicit conversion from HtmlFactory to Ensuring[HtmlFactory] 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:
    (htmlFactory: Ensuring[HtmlFactory]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from HtmlFactory to StringAdd

Inherited by implicit conversion any2stringfmt from HtmlFactory to StringFormat

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

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

Ungrouped