diff options
author | vmishenev <vad-mishenev@yandex.ru> | 2021-07-28 14:57:38 +0300 |
---|---|---|
committer | vmishenev <vad-mishenev@yandex.ru> | 2021-07-28 19:11:50 +0300 |
commit | f03083d7534209ad94dc3c4d7afd17f58e58127d (patch) | |
tree | 8160e6e8d376fc16ad559cfa59048c5447d2e2bd /examples/gradle/dokka-multimodule-example/parentProject/childProjectA | |
parent | 2cd95b0828518dde751d039f4456dcf93e04dfc1 (diff) | |
download | dokka-f03083d7534209ad94dc3c4d7afd17f58e58127d.tar.gz dokka-f03083d7534209ad94dc3c4d7afd17f58e58127d.tar.bz2 dokka-f03083d7534209ad94dc3c4d7afd17f58e58127d.zip |
Migrate Dokka examples to Dokka repo (KT-47798) (#2030)
* Migrate Dokka examples to Dokka repo (KT-47798)
* Configure workflow of examples checking
* Add workflow to deploy examples
Diffstat (limited to 'examples/gradle/dokka-multimodule-example/parentProject/childProjectA')
3 files changed, 31 insertions, 0 deletions
diff --git a/examples/gradle/dokka-multimodule-example/parentProject/childProjectA/Module.md b/examples/gradle/dokka-multimodule-example/parentProject/childProjectA/Module.md new file mode 100644 index 00000000..e6cf0e04 --- /dev/null +++ b/examples/gradle/dokka-multimodule-example/parentProject/childProjectA/Module.md @@ -0,0 +1,5 @@ +# Module childProjectA +This is the child module a + +# Package demo +This package contains a few examples of Dokka usage. diff --git a/examples/gradle/dokka-multimodule-example/parentProject/childProjectA/build.gradle.kts b/examples/gradle/dokka-multimodule-example/parentProject/childProjectA/build.gradle.kts new file mode 100644 index 00000000..b3c42aba --- /dev/null +++ b/examples/gradle/dokka-multimodule-example/parentProject/childProjectA/build.gradle.kts @@ -0,0 +1,18 @@ +import org.jetbrains.dokka.gradle.DokkaTaskPartial + +plugins { + kotlin("jvm") + id("org.jetbrains.dokka") +} + +dependencies { + implementation(kotlin("stdlib")) +} + +tasks.withType<DokkaTaskPartial>().configureEach { + dokkaSourceSets { + configureEach { + includes.from("Module.md") + } + } +} diff --git a/examples/gradle/dokka-multimodule-example/parentProject/childProjectA/src/main/kotlin/demo/ChildProjectAClass.kt b/examples/gradle/dokka-multimodule-example/parentProject/childProjectA/src/main/kotlin/demo/ChildProjectAClass.kt new file mode 100644 index 00000000..533b305c --- /dev/null +++ b/examples/gradle/dokka-multimodule-example/parentProject/childProjectA/src/main/kotlin/demo/ChildProjectAClass.kt @@ -0,0 +1,8 @@ +@file:Suppress("unused") + +package demo + +/** + * Class defined in child project a + */ +class ChildProjectAClass |