class HtmlFactory extends AnyRef
A class that can generate Scaladoc sites to some fixed root folder.
- Source
- HtmlFactory.scala
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- HtmlFactory
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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
-
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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
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.
-
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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.
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def libResources: collection.immutable.List[String]
-
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()
- val reporter: Reporter
- def siteRoot: File
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
- val universe: Universe
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- final def webjarResources: collection.immutable.List[(String, String)]
- def writeTemplates(writeForThis: (HtmlPage) ⇒ Unit): Unit
-
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
-
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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
The Scala compiler and reflection APIs.