diff options
Diffstat (limited to 'doc-tool/src/dotty/tools/dottydoc/api/scala/Dottydoc.scala')
-rw-r--r-- | doc-tool/src/dotty/tools/dottydoc/api/scala/Dottydoc.scala | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/doc-tool/src/dotty/tools/dottydoc/api/scala/Dottydoc.scala b/doc-tool/src/dotty/tools/dottydoc/api/scala/Dottydoc.scala index 1d0891bc2..9d00b08a3 100644 --- a/doc-tool/src/dotty/tools/dottydoc/api/scala/Dottydoc.scala +++ b/doc-tool/src/dotty/tools/dottydoc/api/scala/Dottydoc.scala @@ -7,27 +7,27 @@ import scala.collection.Map import java.net.URL /** 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: - * - * ```scala - * 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). - * - * ```scala - * buildDocs("path/to/output/dir", templateURL, resources, index) - * ``` - * - * The tool can also generate JSON from the created index using `indexToJson` - * or directly using `createJsonIndex` - */ + * `createIndex` with the same argument list as you would the compiler - e.g: + * + * ```scala + * 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). + * + * ```scala + * buildDocs("path/to/output/dir", templateURL, resources, index) + * ``` + * + * The tool can also generate JSON from the created index using `indexToJson` + * or directly using `createJsonIndex` + */ trait Dottydoc extends DocDriver { /** Creates index from compiler arguments */ def createIndex(args: Array[String]): Map[String, Package] = |