Packages

c

scala.tools.nsc.doc.html

HtmlFactory

class HtmlFactory extends AnyRef

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

Source
HtmlFactory.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HtmlFactory
  2. AnyRef
  3. 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 HtmlFactory(universe: Universe, reporter: Reporter)

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 HtmlFactory to any2stringadd[HtmlFactory] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HtmlFactory, B)
    Implicit
    This member is added by an implicit conversion from HtmlFactory to ArrowAssoc[HtmlFactory] 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. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. 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.

  9. def ensuring(cond: (HtmlFactory) ⇒ Boolean, msg: ⇒ Any): HtmlFactory
    Implicit
    This member is added by an implicit conversion from HtmlFactory to Ensuring[HtmlFactory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (HtmlFactory) ⇒ Boolean): HtmlFactory
    Implicit
    This member is added by an implicit conversion from HtmlFactory to Ensuring[HtmlFactory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): HtmlFactory
    Implicit
    This member is added by an implicit conversion from HtmlFactory to Ensuring[HtmlFactory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): HtmlFactory
    Implicit
    This member is added by an implicit conversion from HtmlFactory to Ensuring[HtmlFactory] 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

    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.

  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def libResources: collection.immutable.List[String]
  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. val reporter: Reporter
  25. def siteRoot: File
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. val universe: Universe
  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. final def webjarResources: collection.immutable.List[(String, String)]
  33. def writeTemplates(writeForThis: (HtmlPage) ⇒ Unit): Unit
  34. def →[B](y: B): (HtmlFactory, B)
    Implicit
    This member is added by an implicit conversion from HtmlFactory to ArrowAssoc[HtmlFactory] 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 HtmlFactory to StringFormat[HtmlFactory] 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 AnyRef

Inherited from Any

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

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

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

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

Ungrouped