class DocFactory extends AnyRef
A documentation processor controls the process of generating Scala documentation, which is as follows.
* A simplified compiler instance (with only the front-end phases enabled)
* is created, and additional sourceless comments are registered.
* Documentable files are compiled, thereby filling the compiler's symbol table.
* A documentation model is extracted from the post-compilation symbol table.
* A generator is used to transform the model into the correct final format (HTML).
A processor contains a single compiler instantiated from the processor's
settings. Each call to document uses the same compiler instance with
the same symbol table. In particular, this implies that the scaladoc site
obtained from a call to run will contain documentation about files compiled
during previous calls to the same processor's run method.
- Self Type
- DocFactory
- Source
- DocFactory.scala
- Alphabetic
- By Inheritance
- DocFactory
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
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 DocFactory toany2stringadd[DocFactory] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (DocFactory, B)
- Implicit
- This member is added by an implicit conversion from DocFactory toArrowAssoc[DocFactory] 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(classOf[java.lang.CloneNotSupportedException]) @native()
- def document(files: List[String]): Unit
Generate document(s) for all
filescontaining scaladoc documentation.Generate document(s) for all
filescontaining scaladoc documentation.- files
The list of paths (relative to the compiler's source path, or absolute) of files to document.
- val documentError: PartialFunction[Throwable, Unit]
- def ensuring(cond: (DocFactory) => Boolean, msg: => Any): DocFactory
- Implicit
- This member is added by an implicit conversion from DocFactory toEnsuring[DocFactory] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (DocFactory) => Boolean): DocFactory
- Implicit
- This member is added by an implicit conversion from DocFactory toEnsuring[DocFactory] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): DocFactory
- Implicit
- This member is added by an implicit conversion from DocFactory toEnsuring[DocFactory] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): DocFactory
- Implicit
- This member is added by an implicit conversion from DocFactory toEnsuring[DocFactory] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from DocFactory toStringFormat[DocFactory] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def makeUniverse(source: Either[List[String], String]): Option[Universe]
Creates a scaladoc site for all symbols defined in this call's
source, as well as those defined insourcesof previous calls to the same processor.Creates a scaladoc site for all symbols defined in this call's
source, as well as those defined insourcesof previous calls to the same processor.- source
The list of paths (relative to the compiler's source path, or absolute) of files to document or the source code.
- 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 runReporting: compiler.PerRunReporting
- val settings: Settings
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- object NoCompilerRunException extends ControlThrowable
- object compiler extends ScaladocGlobal
The unique compiler instance used by this processor and constructed from its
settings.
Deprecated Value Members
- def →[B](y: B): (DocFactory, B)
- Implicit
- This member is added by an implicit conversion from DocFactory toArrowAssoc[DocFactory] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
The Scala compiler and reflection APIs.