Dotty Documentation

0.11.0-bin-SNAPSHOT

package dotty.tools.dottydoc

[-] Constructors

[-] Members

[+] class DocCompiler

Custom Compiler with phases for the documentation tool

The idea here is to structure dottydoc around the new infrastructure. As such, dottydoc will itself be a compiler. It will, however, produce a format that can be used by other tools or web-browsers.

Example: 1. Use the existing FrontEnd to typecheck the code being fed to dottydoc, wihtout discarding AnyVal interfaces 2. Create an AST that is serializable 3. Serialize to JS object

[+] class DocDriver

DocDriver implements the main entry point to the Dotty documentation tool. It's methods are used by the external scala and java APIs.

[+] class DocFrontEnd

DocFrontEnd uses the Dotty FrontEnd without discarding the AnyVal interfaces for Boolean, Int, Char, Long, Byte etc.

If -from-tasty is set, then the trees and documentation will be loaded from TASTY. The comments will be cooked after being unpickled.

It currently still throws away Java sources by overriding discardAfterTyper.

[+] object Main

Main runnable for DottyDoc