Scala Compiler 2.13.16 - scala.tools.nsc.doc.doclet
Keywords: Scala Compiler 2.13.16 scala.tools.nsc.doc.doclet

Scala Compiler2.13.16 < Back


# Packages

-  package root

  The Scala compiler and reflection APIs.

  The Scala compiler and reflection APIs.

  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package tools
  Definition Classes
    scala
-  package nsc
  Definition Classes
    tools
-  package doc
  Definition Classes
    nsc
-  package base
  Definition Classes
    doc
-  package doclet
  Definition Classes
    doc
- Generator
- Universer
-  package html
  Definition Classes
    doc
-  package model
  Definition Classes
    doc

p

scala.tools.nsc.doc

# doclet

#### package doclet

Content Hierarchy

### Type Members

1.  abstract class Generator extends AnyRef

   Custom Scaladoc generators must implement the `Generator` class.

   Custom Scaladoc generators must implement the `Generator` class. A custom generator can be selected in Scaladoc using the `-doc-generator` command line option. The `Generator` class does not provide data about the documented code. A number of data provider traits can be used to configure what data is actually available to the generator:

   - A `Universer` provides a `Universe` data structure representing the interfaces and comments of the documented program. To implement this class only requires defining method `generateImpl`.
2.  trait Universer extends Generator

   A `Generator` may implement the `Universer` trait to gain access to a model of the documented program

### Ungrouped