Groovy
Groovydoc
Uses a Groovy's Groovydoc APIs to produce a JSON format that Orchid can use to generate a documentation site.
Usage
// build.gradle.kts
repositories {
jcenter()
}
dependencies {
compile 'com.eden.kodiak:groovydoc-runner:0.5.0'
}
var cacheDir: Path = Files.createTempDirectory("groovydocCache")
val runner: GroovydocInvoker = GroovydocInvokerImpl(cacheDir)
val outputDir = File("build/groovydoc").canonicalFile.toPath()
outputDir.toFile().deleteRecursively()
outputDir.toFile().mkdirs()
val rootDoc = runner.getRootDoc(
listOf(
File("src/main/java").canonicalFile.toPath(),
File("src/main/groovy").canonicalFile.toPath()
),
outputDir
) { inputStream -> IOStreamUtils.InputStreamPrinter(inputStream, null) }
rootDoc.packages.forEach { processPackage(it) }
rootDoc.classes.forEach { processClass(it) }
- skip by including
@suppress
in its comments- classes
- constructors
- fields
- methods
References
API Documentation: