diff options
Diffstat (limited to 'doc-tool/src/dotty/tools/dottydoc/api/java/Dottydoc.java')
-rw-r--r-- | doc-tool/src/dotty/tools/dottydoc/api/java/Dottydoc.java | 48 |
1 files changed, 0 insertions, 48 deletions
diff --git a/doc-tool/src/dotty/tools/dottydoc/api/java/Dottydoc.java b/doc-tool/src/dotty/tools/dottydoc/api/java/Dottydoc.java deleted file mode 100644 index a44413c75..000000000 --- a/doc-tool/src/dotty/tools/dottydoc/api/java/Dottydoc.java +++ /dev/null @@ -1,48 +0,0 @@ -package dotty.tools.dottydoc.api.java; - -import dotty.tools.dottydoc.DocDriver; -import dotty.tools.dottydoc.model.Package; -import java.util.Map; -import java.util.List; -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: - * - * {{{ - * String[] array = { - * "-language:Scala2" - * }; - * - * Map<String, Package> index = 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 "toJson(index)" - * or directly using "createJsonIndex" - */ -public class Dottydoc { - private DocDriver driver = new DocDriver(); - - /** Creates index from compiler arguments */ - public Map<String, Package> createIndex(String[] args) { - return driver.compiledDocsJava(args); - } - - /** Creates JSON from compiler arguments */ - public String createJsonIndex(String[] args) { - return driver.indexToJsonJava(createIndex(args)); - } - - public String toJson(Map<String, Package> index) { - return driver.indexToJsonJava(index); - } -} |