Scala Compiler2.12.3-1 < 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 ast
  Definition Classes
    nsc
-  package backend
  Definition Classes
    nsc
-  package classpath
  Definition Classes
    nsc
-  package doc
  Definition Classes
    nsc
-  package base
-  package doclet
-  package html
-  package model
- DocFactory
- DocParser
- Index
- ScaladocAnalyzer
- ScaladocGlobal
- ScaladocGlobalTrait
- ScaladocSyntaxAnalyzer
- Settings
- Uncompilable
- Universe
-  package interactive
  Definition Classes
    nsc
-  package interpreter

  The main REPL related classes and values are as follows.

  The main REPL related classes and values are as follows. In addition to standard compiler classes Global and Settings, there are:

  History: an interface for session history. Completion: an interface for tab completion. ILoop (formerly InterpreterLoop): The umbrella class for a session. IMain (formerly Interpreter): Handles the evolving state of the session and handles submitting code to the compiler and handling the output. InteractiveReader: how ILoop obtains input. History: an interface for session history. Completion: an interface for tab completion. Power: a repository for more advanced/experimental features.

  ILoop contains { in: InteractiveReader, intp: IMain, settings: Settings, power: Power } InteractiveReader contains { history: History, completion: Completion } IMain contains { global: Global }

  Definition Classes
    nsc
-  package io
  Definition Classes
    nsc
-  package javac
  Definition Classes
    nsc
-  package plugins
  Definition Classes
    nsc
-  package profile
  Definition Classes
    nsc
-  package reporters
  Definition Classes
    nsc
-  package settings
  Definition Classes
    nsc
-  package symtab
  Definition Classes
    nsc
-  package transform
  Definition Classes
    nsc
-  package typechecker
  Definition Classes
    nsc
-  package util
  Definition Classes
    nsc

p

scala.tools.nsc

# doc 

#### package doc

Content Hierarchy
 
Ordering

1. Alphabetic

Visibility

1. Public
2. All

### Type Members

1.  class DocFactory extends AnyRef

   A documentation processor controls the process of generating Scala documentation, which is as follows.

   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.

2.  class DocParser extends Global with ScaladocGlobalTrait

   A very minimal global customized for extracting `DocDefs`.

   A very minimal global customized for extracting `DocDefs`. It stops right after parsing so it can read `DocDefs` from source code which would otherwise cause the compiler to go haywire.

3.  trait Index extends AnyRef
4.  trait ScaladocAnalyzer extends Analyzer
5.  class ScaladocGlobal extends Global with ScaladocGlobalTrait
6.  trait ScaladocGlobalTrait extends Global
7.  abstract class ScaladocSyntaxAnalyzer [G <: Global] extends SyntaxAnalyzer
8.  class Settings extends nsc.Settings

   An extended version of compiler settings, with additional Scaladoc-specific options.

9.  trait Uncompilable extends AnyRef

   Some glue between DocParser (which reads source files which can't be compiled) and the scaladoc model.

10.  trait Universe extends AnyRef

    Class to hold common dependencies across Scaladoc classes.

### Value Members

1.  object DocParser

   Since the DocParser's whole reason for existing involves trashing a global, it is designed to bottle up general `Global#Tree` types rather than path dependent ones.

   Since the DocParser's whole reason for existing involves trashing a global, it is designed to bottle up general `Global#Tree` types rather than path dependent ones. The recipient will have to deal.

### Ungrouped