Update Dokka configuration

tclement0922 · Nov 15, 2023 · bfe27a4 · bfe27a4
1 parent 60e8b7b
commit bfe27a4
Show file tree

Hide file tree

Showing 3,506 changed files with 59,702 additions and 56,252 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -16,8 +16,12 @@
 
 import org.jetbrains.dokka.base.DokkaBase
 import org.jetbrains.dokka.base.DokkaBaseConfiguration
+import org.jetbrains.dokka.gradle.AbstractDokkaLeafTask
+import org.jetbrains.dokka.gradle.AbstractDokkaParentTask
+import org.jetbrains.dokka.gradle.AbstractDokkaTask
 import org.jetbrains.dokka.gradle.DokkaTaskPartial
 import org.jetbrains.kotlin.konan.properties.loadProperties
+import java.net.URL
 
 plugins {
     alias(libs.plugins.kotlin.multiplatform) apply false
@@ -37,21 +41,42 @@ buildscript {
 
 val libProperties = loadProperties(rootDir.absolutePath + "/library.properties")
 
-tasks.dokkaHtmlMultiModule {
-    outputDirectory.set(rootDir.resolve("docs"))
-    moduleVersion.set(libProperties["version"] as? String)
-
-    pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
-        footerMessage = "(c) 2023 T. Clément (@tclement0922)"
-        mergeImplicitExpectActualDeclarations = false
-    }
-}
-
 fun Project.configureDokka() {
-    tasks.withType(DokkaTaskPartial::class) {
+    tasks.withType(AbstractDokkaTask::class) {
+        pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
+            footerMessage = "Copyright (c) 2023 T. Clément (@tclement0922)"
+            mergeImplicitExpectActualDeclarations = false
+            customStyleSheets =
+                listOf(rootDir.resolve("docs-assets/sourcesets.css"))
+        }
+    }
+    tasks.withType(AbstractDokkaParentTask::class) {
+        outputDirectory.set(rootDir.resolve("docs"))
+        moduleVersion.set(libProperties["version"] as? String)
+    }
+    tasks.withType(AbstractDokkaLeafTask::class) {
         dokkaSourceSets {
             configureEach {
+                val newName = when (displayName.orNull) {
+                    "common" -> "Common"
+                    "androidJvm" -> "Android"
+                    else -> when {
+                        name.startsWith("android") -> "Android"
+                        name.startsWith("skiko") -> "Skiko (Desktop & Web)"
+                        name.startsWith("desktop") -> "Desktop (JVM)"
+                        name.startsWith("js") -> "Web (JS)"
+                        name.startsWith("web") -> "Web"
+                        else -> name
+                    }
+                }
+                displayName.set(newName)
                 reportUndocumented = true
+
+                sourceLink {
+                    localDirectory.set(projectDir.resolve("src"))
+                    remoteUrl.set(URL("https://github.com/tclement0922/compose-font-icons/tree/main/${projectDir.toRelativeString(rootDir)}/src"))
+                    remoteLineSuffix.set("#L")
+                }
             }
         }
     }

diff --git a/docs-assets/sourcesets.css b/docs-assets/sourcesets.css
@@ -0,0 +1,3 @@
+.js-like, .jvm-like, .wasm-like {
+    text-transform: none!important;
+}
diff --git a/docs/core-glance/dev.tclement.fonticons.glance/-font-icon.html b/docs/core-glance/dev.tclement.fonticons.glance/-font-icon.html
diff --git a/docs/core-glance/dev.tclement.fonticons.glance/-local-glance-icon-tint.html b/docs/core-glance/dev.tclement.fonticons.glance/-local-glance-icon-tint.html
@@ -30,7 +30,8 @@
 <script type="text/javascript" src="../../scripts/platform-content-handler.js" async></script>
 <script type="text/javascript" src="../../scripts/main.js" defer></script>
 <script type="text/javascript" src="../../scripts/prism.js" async></script>
-<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
+<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer></script>
+<link href="../../styles/sourcesets.css" rel="Stylesheet"></head>
 <body>
     <div class="root">
 <nav class="navigation" id="navigation-wrapper">
@@ -45,7 +46,7 @@
             </div>
         </div>
         <div class="filter-section" id="filter-section">
-                <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":core-glance:dokkaHtmlPartial/release">androidJvm</button>
+                <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":core-glance:dokkaHtmlPartial/release">Android</button>
         </div>
     </div>
     <div class="navigation-controls">
@@ -58,15 +59,15 @@
                 <div class="sidebar--inner" id="sideMenu"></div>
             </div>
             <div id="main">
-<div class="main-content" data-page-type="member" id="content" pageids="core-glance::dev.tclement.fonticons.glance//LocalGlanceIconTint/#/PointingToDeclaration//637312259">
+<div class="main-content" data-page-type="member" id="content" pageids="core-glance::dev.tclement.fonticons.glance//LocalGlanceIconTint/#/PointingToDeclaration//1928404472">
   <div class="breadcrumbs"><a href="../index.html">core-glance</a><span class="delimiter">/</span><a href="index.html">dev.tclement.fonticons.glance</a><span class="delimiter">/</span><span class="current">LocalGlanceIconTint</span></div>
   <div class="cover ">
     <h1 class="cover"><span>Local</span><wbr><span>Glance</span><wbr><span>Icon</span><wbr><span><span>Tint</span></span></h1>
   </div>
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core-glance:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="-local-glance-icon-tint.html">LocalGlanceIconTint</a><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/ProvidableCompositionLocal.html">ProvidableCompositionLocal</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://developer.android.com/reference/kotlin/androidx/glance/unit/ColorProvider.html">ColorProvider</a><span class="token operator">&gt;</span></div><p class="paragraph">Default icon tint for Glance (a <a href="https://developer.android.com/reference/kotlin/androidx/glance/unit/ColorProvider.html">ColorProvider</a>) used when none is provided as a parameter of one of the FontIcon functions.</p><p class="paragraph">No default value (will throw an error if not provided).</p><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":core-glance:dokkaHtmlPartial/release" data-filterable-set=":core-glance:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html"><span>Illegal</span><wbr><span>State</span><wbr><span><span>Exception</span></span></a></div></span></div><div><div class="title"><p class="paragraph">if no value is provided.</p></div></div></div></div></div></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>Copyright (c) 2023 T. Clément (@tclement0922)</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>
             </div>
         </div>

diff --git a/docs/core-glance/dev.tclement.fonticons.glance/-provide-glance-icon-parameters.html b/docs/core-glance/dev.tclement.fonticons.glance/-provide-glance-icon-parameters.html
@@ -30,7 +30,8 @@
 <script type="text/javascript" src="../../scripts/platform-content-handler.js" async></script>
 <script type="text/javascript" src="../../scripts/main.js" defer></script>
 <script type="text/javascript" src="../../scripts/prism.js" async></script>
-<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
+<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer></script>
+<link href="../../styles/sourcesets.css" rel="Stylesheet"></head>
 <body>
     <div class="root">
 <nav class="navigation" id="navigation-wrapper">
@@ -45,7 +46,7 @@
             </div>
         </div>
         <div class="filter-section" id="filter-section">
-                <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":core-glance:dokkaHtmlPartial/release">androidJvm</button>
+                <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":core-glance:dokkaHtmlPartial/release">Android</button>
         </div>
     </div>
     <div class="navigation-controls">
@@ -58,15 +59,15 @@
                 <div class="sidebar--inner" id="sideMenu"></div>
             </div>
             <div id="main">
-<div class="main-content" data-page-type="member" id="content" pageids="core-glance::dev.tclement.fonticons.glance//ProvideGlanceIconParameters/#dev.tclement.fonticons.IconFont#androidx.compose.ui.unit.Dp#androidx.glance.unit.ColorProvider#androidx.compose.ui.text.font.FontWeight#kotlin.Function0[kotlin.Unit]/PointingToDeclaration//637312259">
+<div class="main-content" data-page-type="member" id="content" pageids="core-glance::dev.tclement.fonticons.glance//ProvideGlanceIconParameters/#dev.tclement.fonticons.IconFont#androidx.compose.ui.unit.Dp#androidx.glance.unit.ColorProvider#androidx.compose.ui.text.font.FontWeight#kotlin.Function0[kotlin.Unit]/PointingToDeclaration//1928404472">
   <div class="breadcrumbs"><a href="../index.html">core-glance</a><span class="delimiter">/</span><a href="index.html">dev.tclement.fonticons.glance</a><span class="delimiter">/</span><span class="current">ProvideGlanceIconParameters</span></div>
   <div class="cover ">
     <h1 class="cover"><span>Provide</span><wbr><span>Glance</span><wbr><span>Icon</span><wbr><span><span>Parameters</span></span></h1>
   </div>
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core-glance:dokkaHtmlPartial/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="-provide-glance-icon-parameters.html"><span class="token function">ProvideGlanceIconParameters</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">iconFont<span class="token operator">: </span><a href="../../core/dev.tclement.fonticons/-icon-font/index.html">IconFont</a><span class="token operator"> = </span>LocalIconFont.current<span class="token punctuation">, </span></span><span class="parameter ">size<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp.html">Dp</a><span class="token operator"> = </span>LocalIconSize.current<span class="token punctuation">, </span></span><span class="parameter ">tint<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/glance/unit/ColorProvider.html">ColorProvider</a><span class="token operator"> = </span>LocalGlanceIconTint.current<span class="token punctuation">, </span></span><span class="parameter ">weight<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontWeight.html">FontWeight</a><span class="token operator"> = </span>LocalIconWeight.current<span class="token punctuation">, </span></span><span class="parameter ">content<span class="token operator">: </span><span><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a>&nbsp;</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span></div></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>Copyright (c) 2023 T. Clément (@tclement0922)</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>
             </div>
         </div>