dotty.tools.dottydoc.api.scala

Dottydoc

Related Doc: package scala

trait Dottydoc extends DocDriver

The Dottydoc API is fairly simple. The tool creates an index by calling: "createIndex" with the same argument list as you would the compiler - e.g:

val array: Array[String] = Array(
  "-language:Scala2"
)

val index: Map[String, Package] = createIndex(array)

Once the index has been generated, the tool can also build a documentation API given a Mustache template and a flat resources structure (i.e. absolute paths to each resource, which will be put in the same directory).

buildDocs("path/to/output/dir", templateURL, resources, index)

The tool can also generate JSON from the created index using "indexToJson" or directly using "createJsonIndex"

Linear Supertypes
DocDriver, Driver, DotClass, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Dottydoc
  2. DocDriver
  3. Driver
  4. DotClass
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

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

    Creates a documentation from the given parameters

  6. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    DocDriver

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

    Definition Classes
    DocDriver

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

    Creates index from compiler arguments

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

    Creates JSON from compiler arguments

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

    Attributes
    protected
    Definition Classes
    Driver

  12. def emptyReporter: Reporter

    Attributes
    protected
    Definition Classes
    Driver

  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    DocDriver

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

    Definition Classes
    DocDriver

  20. def initCtx: Context

    Attributes
    protected
    Definition Classes
    Driver

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    Driver

  23. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  24. def newCompiler(implicit ctx: Context): Compiler

    Definition Classes
    DocDriver → Driver

  25. final def notify(): Unit

    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

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

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

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

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

    Definition Classes
    DocDriver → Driver

  32. def sourcesRequired: Boolean

    Attributes
    protected
    Definition Classes
    Driver

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

    Definition Classes
    AnyRef

  34. def toString(): String

    Definition Classes
    AnyRef → Any

  35. def unsupported(methodName: String): Nothing

    Throws an UnsupportedOperationException with the given method name.

    Throws an UnsupportedOperationException with the given method name.

    Definition Classes
    DotClass

  36. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  38. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Writes JSON to an output directory as "index.json"

Inherited from DocDriver

Inherited from Driver

Inherited from DotClass

Inherited from AnyRef

Inherited from Any

Ungrouped