Packages

c

scala.tools.nsc.doc

DocFactory

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
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocFactory
  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. Protected

Instance Constructors

  1. new DocFactory(reporter: Reporter, settings: Settings)

    reporter

    The reporter to which both documentation and compilation errors will be reported.

    settings

    The settings to be used by the documenter and compiler for generating documentation.

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 DocFactory toany2stringadd[DocFactory] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. 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()
  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(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def document(files: List[String]): Unit

    Generate document(s) for all files containing scaladoc documentation.

    Generate document(s) for all files containing scaladoc documentation.

    files

    The list of paths (relative to the compiler's source path, or absolute) of files to document.

  9. val documentError: PartialFunction[Throwable, Unit]
  10. 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
  11. 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
  12. 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
  13. 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
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def getClass(): Class[_ <: AnyRef]
    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 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 in sources of previous calls to the same processor.

    Creates a scaladoc site for all symbols defined in this call's source, as well as those defined in sources of 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.

  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 runReporting: compiler.PerRunReporting
  26. val settings: Settings
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. object NoCompilerRunException extends ControlThrowable
  33. object compiler extends ScaladocGlobal

    The unique compiler instance used by this processor and constructed from its settings.

Deprecated Value Members

  1. 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
    @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.

  2. 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.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromDocFactory to any2stringadd[DocFactory]

Inherited by implicit conversion StringFormat fromDocFactory to StringFormat[DocFactory]

Inherited by implicit conversion Ensuring fromDocFactory to Ensuring[DocFactory]

Inherited by implicit conversion ArrowAssoc fromDocFactory to ArrowAssoc[DocFactory]

Ungrouped