Skip to content

Commit 2c2db32

Browse files
adam-enkowhyoleg
andauthored
Add DGPv2 example projects (#3820)
* Add DGPv2 examples - Convert the existing DGPv1 examples to demonstrate DGPv2. - Import [Dokkatoo examples](https://github.com/adamko-dev/dokkatoo/tree/v2.4.0/examples). Part of KT-71346 To keep the PR smaller, tests to ensure these projects work as expected will be added in a following PR. * add gradle.properties files * update readme * fix composite-build-example, and update its README * Update version-multimodule example readme * fix typo 2 -> v2 Co-authored-by: Oleg Yukhnevich <whyoleg@gmail.com> * rename 'custom format' example to 'custom styling', because 'format' is easy to confuse with the Dokka HTML/Javadoc output formats. * fix typo in 'asyncWithDealy' * bump kotlinx-coroutines-core in example * add more KMP examples * update DGPv2 opt-in flags * remove custom source set in v2 kmp example --------- Co-authored-by: Oleg Yukhnevich <whyoleg@gmail.com>
1 parent 361f074 commit 2c2db32

File tree

181 files changed

+4255
-22
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

181 files changed

+4255
-22
lines changed

dokka-integration-tests/gradle/projects/ui-showcase/kmp/src/commonMain/kotlin/org/jetbrains/dokka/uitest/kmp/coroutines/CommonCoroutineExtensions.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import kotlinx.coroutines.Deferred
77
/**
88
* Common `expect` declaration
99
*/
10-
expect fun <T> CoroutineScope.asyncWithDealy(delay: Long, block: suspend () -> T): Deferred<T>
10+
expect fun <T> CoroutineScope.asyncWithDelay(delay: Long, block: suspend () -> T): Deferred<T>
1111

1212
/**
1313
* Common coroutine extension

dokka-integration-tests/gradle/projects/ui-showcase/kmp/src/jsMain/kotlin/org/jetbrains/dokka/uitest/kmp/coroutines/JsCoroutineExtensions.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ import kotlinx.coroutines.Deferred
66
/**
77
* JS actual implementation for `asyncWithDelay`
88
*/
9-
actual fun <T> CoroutineScope.asyncWithDealy(delay: Long, block: suspend () -> T): Deferred<T> {
9+
actual fun <T> CoroutineScope.asyncWithDelay(delay: Long, block: suspend () -> T): Deferred<T> {
1010
TODO("Not yet implemented")
1111
}

dokka-integration-tests/gradle/projects/ui-showcase/kmp/src/jvmMain/kotlin/org/jetbrains/dokka/uitest/kmp/coroutines/JvmCoroutineExtensions.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ import kotlinx.coroutines.Deferred
66
/**
77
* JVM actual implementation for `asyncWithDelay`
88
*/
9-
actual fun <T> CoroutineScope.asyncWithDealy(delay: Long, block: suspend () -> T): Deferred<T> {
9+
actual fun <T> CoroutineScope.asyncWithDelay(delay: Long, block: suspend () -> T): Deferred<T> {
1010
TODO("Not yet implemented")
1111
}

dokka-integration-tests/gradle/projects/ui-showcase/kmp/src/linuxMain/kotlin/org/jetbrains/dokka/uitest/kmp/coroutines/LinuxCoroutineExtensions.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ import kotlinx.coroutines.Deferred
66
/**
77
* Linux actual implementation for `asyncWithDelay`
88
*/
9-
actual fun <T> CoroutineScope.asyncWithDealy(delay: Long, block: suspend () -> T): Deferred<T> {
9+
actual fun <T> CoroutineScope.asyncWithDelay(delay: Long, block: suspend () -> T): Deferred<T> {
1010
TODO("Not yet implemented")
1111
}

dokka-integration-tests/gradle/projects/ui-showcase/kmp/src/macosMain/kotlin/org/jetbrains/dokka/uitest/kmp/coroutines/MacOsCoroutineExtensions.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ import kotlinx.coroutines.Deferred
66
/**
77
* MacOS actual implementation for `asyncWithDelay`
88
*/
9-
actual fun <T> CoroutineScope.asyncWithDealy(delay: Long, block: suspend () -> T): Deferred<T> {
9+
actual fun <T> CoroutineScope.asyncWithDelay(delay: Long, block: suspend () -> T): Deferred<T> {
1010
TODO("Not yet implemented")
1111
}

dokka-integration-tests/gradle/projects/ui-showcase/previousDocVersions/0.9/jvm/navigation.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@
382382
<div class="overview">
383383
<span class="navButton" onclick="document.getElementById(&quot;kmp-nav-submenu-2&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../kmp/org.jetbrains.dokka.uitest.kmp.coroutines/index.html"><span>org.</span><wbr><span>jetbrains.</span><wbr><span>dokka.</span><wbr><span>uitest.</span><wbr><span>kmp.</span><wbr><span>coroutines</span></a>
384384
</div>
385-
<div class="sideMenuPart" id="kmp-nav-submenu-2-0" pageid="kmp::org.jetbrains.dokka.uitest.kmp.coroutines//asyncWithDealy/kotlinx.coroutines.CoroutineScope#kotlin.Long#kotlin.coroutines.SuspendFunction0[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration//1562624156">
385+
<div class="sideMenuPart" id="kmp-nav-submenu-2-0" pageid="kmp::org.jetbrains.dokka.uitest.kmp.coroutines//asyncWithDelay/kotlinx.coroutines.CoroutineScope#kotlin.Long#kotlin.coroutines.SuspendFunction0[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration//1562624156">
386386
<div class="overview">
387387
<a href="../kmp/org.jetbrains.dokka.uitest.kmp.coroutines/async-with-dealy.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon function"></span><span class="nav-link-child"><span>async</span><wbr><span>With</span><wbr><span><span>Dealy()</span></span></span></span></a>
388388
</div>

dokka-integration-tests/gradle/projects/ui-showcase/previousDocVersions/0.9/kmp/navigation.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@
382382
<div class="overview">
383383
<span class="navButton" onclick="document.getElementById(&quot;kmp-nav-submenu-2&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../kmp/org.jetbrains.dokka.uitest.kmp.coroutines/index.html"><span>org.</span><wbr><span>jetbrains.</span><wbr><span>dokka.</span><wbr><span>uitest.</span><wbr><span>kmp.</span><wbr><span>coroutines</span></a>
384384
</div>
385-
<div class="sideMenuPart" id="kmp-nav-submenu-2-0" pageid="kmp::org.jetbrains.dokka.uitest.kmp.coroutines//asyncWithDealy/kotlinx.coroutines.CoroutineScope#kotlin.Long#kotlin.coroutines.SuspendFunction0[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration//1562624156">
385+
<div class="sideMenuPart" id="kmp-nav-submenu-2-0" pageid="kmp::org.jetbrains.dokka.uitest.kmp.coroutines//asyncWithDelay/kotlinx.coroutines.CoroutineScope#kotlin.Long#kotlin.coroutines.SuspendFunction0[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration//1562624156">
386386
<div class="overview">
387387
<a href="../kmp/org.jetbrains.dokka.uitest.kmp.coroutines/async-with-dealy.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon function"></span><span class="nav-link-child"><span>async</span><wbr><span>With</span><wbr><span><span>Dealy()</span></span></span></span></a>
388388
</div>

dokka-integration-tests/gradle/projects/ui-showcase/previousDocVersions/0.9/kmp/org.jetbrains.dokka.uitest.kmp.coroutines/async-with-dealy.html

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html class="no-js">
33
<head>
44
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5-
<title>asyncWithDealy</title>
5+
<title>asyncWithDelay</title>
66
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg"> <script>var pathToRoot = "../../";</script>
77
<script>document.documentElement.classList.replace("no-js","js");</script>
88
<script>const storage = localStorage.getItem("dokka-dark-mode")
@@ -63,14 +63,14 @@
6363
<div class="sidebar--inner" id="sideMenu"></div>
6464
</div>
6565
<div id="main">
66-
<div class="main-content" data-page-type="member" id="content" pageids="kmp::org.jetbrains.dokka.uitest.kmp.coroutines//asyncWithDealy/kotlinx.coroutines.CoroutineScope#kotlin.Long#kotlin.coroutines.SuspendFunction0[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration//1562624156">
67-
<div class="breadcrumbs"><a href="../index.html">kmp</a><span class="delimiter">/</span><a href="index.html">org.jetbrains.dokka.uitest.kmp.coroutines</a><span class="delimiter">/</span><span class="current">asyncWithDealy</span></div>
66+
<div class="main-content" data-page-type="member" id="content" pageids="kmp::org.jetbrains.dokka.uitest.kmp.coroutines//asyncWithDelay/kotlinx.coroutines.CoroutineScope#kotlin.Long#kotlin.coroutines.SuspendFunction0[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration//1562624156">
67+
<div class="breadcrumbs"><a href="../index.html">kmp</a><span class="delimiter">/</span><a href="index.html">org.jetbrains.dokka.uitest.kmp.coroutines</a><span class="delimiter">/</span><span class="current">asyncWithDelay</span></div>
6868
<div class="cover ">
6969
<h1 class="cover"><span>async</span><wbr><span>With</span><wbr><span><span>Dealy</span></span></h1>
7070
</div>
7171
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
7272
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":kmp:dokkaHtmlPartial/commonMain" data-filterable-set=":kmp:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kmp:dokkaHtmlPartial/commonMain">common</button><button class="platform-bookmark" data-filterable-current=":kmp:dokkaHtmlPartial/jsMain" data-filterable-set=":kmp:dokkaHtmlPartial/jsMain" data-toggle=":kmp:dokkaHtmlPartial/jsMain">js</button><button class="platform-bookmark" data-filterable-current=":kmp:dokkaHtmlPartial/jvmMain" data-filterable-set=":kmp:dokkaHtmlPartial/jvmMain" data-toggle=":kmp:dokkaHtmlPartial/jvmMain">jvm</button><button class="platform-bookmark" data-filterable-current=":kmp:dokkaHtmlPartial/linuxMain" data-filterable-set=":kmp:dokkaHtmlPartial/linuxMain" data-toggle=":kmp:dokkaHtmlPartial/linuxMain">linux</button></div>
73-
<div class="content sourceset-dependent-content" data-active="" data-togglable=":kmp:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">expect </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt; </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="async-with-dealy.html"><span class="token function">asyncWithDealy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">delay<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="async-with-dealy.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt;</span></div><p class="paragraph">Common <code class="lang-kotlin">expect</code> declaration</p></div><div class="content sourceset-dependent-content" data-togglable=":kmp:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt; </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="async-with-dealy.html"><span class="token function">asyncWithDealy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">delay<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="async-with-dealy.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt;</span></div><p class="paragraph">JS actual implementation for <code class="lang-kotlin">asyncWithDelay</code></p></div><div class="content sourceset-dependent-content" data-togglable=":kmp:dokkaHtmlPartial/jvmMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt; </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="async-with-dealy.html"><span class="token function">asyncWithDealy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">delay<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="async-with-dealy.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt;</span></div><p class="paragraph">JVM actual implementation for <code class="lang-kotlin">asyncWithDelay</code></p></div><div class="content sourceset-dependent-content" data-togglable=":kmp:dokkaHtmlPartial/linuxMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt; </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="async-with-dealy.html"><span class="token function">asyncWithDealy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">delay<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="async-with-dealy.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt;</span></div><p class="paragraph">Linux actual implementation for <code class="lang-kotlin">asyncWithDelay</code></p></div> </div>
73+
<div class="content sourceset-dependent-content" data-active="" data-togglable=":kmp:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">expect </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt; </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="async-with-dealy.html"><span class="token function">asyncWithDelay</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">delay<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="async-with-dealy.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt;</span></div><p class="paragraph">Common <code class="lang-kotlin">expect</code> declaration</p></div><div class="content sourceset-dependent-content" data-togglable=":kmp:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt; </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="async-with-dealy.html"><span class="token function">asyncWithDelay</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">delay<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="async-with-dealy.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt;</span></div><p class="paragraph">JS actual implementation for <code class="lang-kotlin">asyncWithDelay</code></p></div><div class="content sourceset-dependent-content" data-togglable=":kmp:dokkaHtmlPartial/jvmMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt; </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="async-with-dealy.html"><span class="token function">asyncWithDelay</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">delay<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="async-with-dealy.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt;</span></div><p class="paragraph">JVM actual implementation for <code class="lang-kotlin">asyncWithDelay</code></p></div><div class="content sourceset-dependent-content" data-togglable=":kmp:dokkaHtmlPartial/linuxMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt; </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="async-with-dealy.html"><span class="token function">asyncWithDelay</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">delay<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="async-with-dealy.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator">&lt;</span><a href="async-with-dealy.html">T</a><span class="token operator">&gt;</span></div><p class="paragraph">Linux actual implementation for <code class="lang-kotlin">asyncWithDelay</code></p></div> </div>
7474
</div>
7575
<div class="footer">
7676
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
@@ -87,4 +87,3 @@ <h1 class="cover"><span>async</span><wbr><span>With</span><wbr><span><span>Dealy
8787
</div>
8888
</body>
8989
</html>
90-

0 commit comments

Comments
 (0)