mirror of
https://github.com/corda/corda.git
synced 2024-12-26 08:01:09 +00:00
ff1652704e
* Minor: improve javadocs in NodeInfo * Minor: use package descriptions in Kotlin build of api docs too, not just javadocs. * RPC: make RPCConnection non-internal, as it's a core API. Move docs around so they're on public API not internal API. * Add an IntelliJ scope that covers the currently supported Corda API. This is useful when used in combination with the "Highlight public declarations with missing KDoc" inspection. * Ironic: upgrade the version of the Gradle plugin that checks for upgraded versions of things. It had broken due being incompatible with the new versions of Gradle itself. * Docs: flesh out javadocs on ServiceHub * Docs: add @suppress to a few things that were polluting the Dokka docs. * Docs: mention RPC access in NodeInfo javadoc
63 lines
2.4 KiB
Groovy
63 lines
2.4 KiB
Groovy
apply plugin: 'org.jetbrains.dokka'
|
|
apply plugin: 'kotlin'
|
|
|
|
dependencies {
|
|
compile rootProject
|
|
}
|
|
|
|
dokka {
|
|
moduleName = 'corda'
|
|
outputDirectory = file("${rootProject.rootDir}/docs/build/html/api/kotlin")
|
|
processConfigurations = ['compile']
|
|
sourceDirs = files('../core/src/main/kotlin', '../client/jfx/src/main/kotlin', '../client/mock/src/main/kotlin', '../client/rpc/src/main/kotlin', '../node-api/src/main/kotlin', '../finance/src/main/kotlin', '../client/jackson/src/main/kotlin', '../testing/node-driver/src/main/kotlin', '../testing/test-utils/src/main/kotlin')
|
|
includes = ['packages.md']
|
|
jdkVersion = 8
|
|
|
|
externalDocumentationLink {
|
|
url = new URL("http://fasterxml.github.io/jackson-core/javadoc/2.8/")
|
|
}
|
|
externalDocumentationLink {
|
|
url = new URL("https://docs.oracle.com/javafx/2/api/")
|
|
}
|
|
externalDocumentationLink {
|
|
url = new URL("http://www.bouncycastle.org/docs/docs1.5on/")
|
|
}
|
|
}
|
|
|
|
task dokkaJavadoc(type: org.jetbrains.dokka.gradle.DokkaTask) {
|
|
moduleName = 'corda'
|
|
outputFormat = "javadoc"
|
|
outputDirectory = file("${rootProject.rootDir}/docs/build/html/api/javadoc")
|
|
processConfigurations = ['compile']
|
|
sourceDirs = files('../core/src/main/kotlin', '../client/jfx/src/main/kotlin', '../client/mock/src/main/kotlin', '../client/rpc/src/main/kotlin', '../node-api/src/main/kotlin', '../finance/src/main/kotlin', '../client/jackson/src/main/kotlin', '../testing/node-driver/src/main/kotlin', '../testing/test-utils/src/main/kotlin')
|
|
includes = ['packages.md']
|
|
jdkVersion = 8
|
|
|
|
externalDocumentationLink {
|
|
url = new URL("http://fasterxml.github.io/jackson-core/javadoc/2.8/")
|
|
}
|
|
externalDocumentationLink {
|
|
url = new URL("https://docs.oracle.com/javafx/2/api/")
|
|
}
|
|
externalDocumentationLink {
|
|
url = new URL("http://www.bouncycastle.org/docs/docs1.5on/")
|
|
}
|
|
}
|
|
|
|
task buildDocs(dependsOn: ['apidocs', 'makeDocs'])
|
|
task apidocs(dependsOn: ['dokka', 'dokkaJavadoc'])
|
|
|
|
task makeDocs(type: Exec, dependsOn: ['installDocsiteRequirements']) {
|
|
// TODO: Non-msys Windows script
|
|
commandLine 'cmd', '/c', 'bash make-docsite.sh' // Windows
|
|
commandLine 'bash', './make-docsite.sh' // Linux
|
|
}
|
|
|
|
task installDocsiteRequirements(type: Exec) {
|
|
// TODO: Non-msys Windows script
|
|
commandLine 'cmd', '/c', 'bash install-docsite-requirements.sh' // Windows
|
|
commandLine 'bash', './install-docsite-requirements.sh' // Linux
|
|
}
|
|
|
|
apidocs.shouldRunAfter makeDocs
|