Dottydoc

Instance Constructors

new Dottydoc()

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def buildDocs(outputDir: String, template: URL, resources: List[URL], index: Map[String, Package]): Unit
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def compiledDocs(args: Array[String]): Map[String, Package]

Definition Classes
DocDriver
def compiledDocsJava(args: Array[String]): Map[String, Package]

Definition Classes
DocDriver
def createIndex(args: Array[String]): Map[String, Package]
def createJsonIndex(args: Array[String]): String
def doCompile(compiler: Compiler, fileNames: List[String])(implicit ctx: Context): Reporter

Attributes
protected
Definition Classes
Driver
def emptyReporter: Reporter

Attributes
protected
Definition Classes
Driver
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def indexToJson(index: Map[String, Package]): String

Definition Classes
DocDriver
def indexToJsonJava(index: Map[String, Package]): String

Definition Classes
DocDriver
def initCtx: Context

Attributes
protected
Definition Classes
Driver
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def main(args: Array[String]): Unit

Definition Classes
Driver
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def newCompiler(implicit ctx: Context): Compiler

Definition Classes
DocDriver → Driver
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def process(args: Array[String], rootCtx: Context): Reporter

Entry point to the compiler using a custom Context.
Entry point to the compiler using a custom Context.
In most cases, you do not need a custom Context and should instead use one of the other overloads of process. However, the other overloads cannot be overriden, instead you should override this one which they call internally.
Usage example: https://github.com/lampepfl/dotty/tree/master/test/test/OtherEntryPointsTest.scala in method runCompilerWithContext
args
Arguments to pass to the compiler.
rootCtx
The root Context to use.
returns
The Reporter used. Use Reporter#hasErrors to check if compilation succeeded.

Definition Classes
Driver
final def process(args: Array[String]): Reporter

Entry point to the compiler with no optional arguments.
Entry point to the compiler with no optional arguments.
This overload is provided for compatibility reasons: the RawCompiler of sbt expects this method to exist and calls it using reflection. Keeping it means that we can change the other overloads without worrying about breaking compatibility with sbt.

Definition Classes
Driver
final def process(args: Array[String], reporter: Reporter = null, callback: CompilerCallback = null): Reporter

Principal entry point to the compiler.
Principal entry point to the compiler.
Usage example: https://github.com/lampepfl/dotty/tree/master/test/test/OtherEntryPointsTest.scala in method runCompiler
args
Arguments to pass to the compiler.
reporter
Used to log errors, warnings, and info messages. The default reporter is used if this is null.
callback
Used to execute custom code during the compilation process. No callbacks will be executed if this is null.
returns
The Reporter used. Use Reporter#hasErrors to check if compilation succeeded.

Definition Classes
Driver
final def process(args: Array[String], simple: SimpleReporter, callback: CompilerCallback): ReporterResult

Entry point to the compiler that can be conveniently used with Java reflection.
Entry point to the compiler that can be conveniently used with Java reflection.
This entry point can easily be used without depending on the dotty package, you only need to depend on dotty-interfaces and call this method using reflection. This allows you to write code that will work against multiple versions of dotty without recompilation.
The trade-off is that you can only pass a SimpleReporter to this method and not a normal Reporter which is more powerful.
Usage example: https://github.com/lampepfl/dotty/tree/master/test/test/InterfaceEntryPointTest.scala
args
Arguments to pass to the compiler.
simple
Used to log errors, warnings, and info messages. The default reporter is used if this is null.
callback
Used to execute custom code during the compilation process. No callbacks will be executed if this is null.
returns

Definition Classes
Driver
def setup(args: Array[String], rootCtx: Context): (List[String], Context)

Definition Classes
DocDriver → Driver
def sourcesRequired: Boolean

Attributes
protected
Definition Classes
Driver
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toJson(index: Map[String, Package]): String
def toString(): String

Definition Classes
AnyRef → Any
def unsupported(methodName: String): Nothing

Throws an UnsupportedOperationException with the given method name.
Throws an UnsupportedOperationException with the given method name.

Definition Classes
DotClass
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def writeJson(index: Map[String, Package], outputDir: String): Unit

Related Doc: package java

class Dottydoc extends DocDriver

Instance Constructors

new Dottydoc()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def buildDocs(outputDir: String, template: URL, resources: List[URL], index: Map[String, Package]): Unit

def clone(): AnyRef

def compiledDocs(args: Array[String]): Map[String, Package]

def compiledDocsJava(args: Array[String]): Map[String, Package]

def createIndex(args: Array[String]): Map[String, Package]

def createJsonIndex(args: Array[String]): String

def doCompile(compiler: Compiler, fileNames: List[String])(implicit ctx: Context): Reporter

def emptyReporter: Reporter

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def indexToJson(index: Map[String, Package]): String

def indexToJsonJava(index: Map[String, Package]): String

def initCtx: Context

final def isInstanceOf[T0]: Boolean

def main(args: Array[String]): Unit

final def ne(arg0: AnyRef): Boolean

def newCompiler(implicit ctx: Context): Compiler

final def notify(): Unit

final def notifyAll(): Unit

def process(args: Array[String], rootCtx: Context): Reporter

final def process(args: Array[String]): Reporter

final def process(args: Array[String], reporter: Reporter = null, callback: CompilerCallback = null): Reporter

final def process(args: Array[String], simple: SimpleReporter, callback: CompilerCallback): ReporterResult

def setup(args: Array[String], rootCtx: Context): (List[String], Context)

def sourcesRequired: Boolean

final def synchronized[T0](arg0: ⇒ T0): T0

def toJson(index: Map[String, Package]): String

def toString(): String

def unsupported(methodName: String): Nothing

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def writeJson(index: Map[String, Package], outputDir: String): Unit

Inherited from DocDriver

Inherited from Driver

Inherited from DotClass

Inherited from AnyRef

Inherited from Any

Ungrouped