Skip to content

Commit 73400cc

Browse files
committed
Updates Dokka v2 configurations
1 parent 78731b4 commit 73400cc

File tree

5 files changed

+14
-7
lines changed

5 files changed

+14
-7
lines changed

.github/workflows/publish-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
cache: gradle
3434

3535
- name: Build Dokka HTML
36-
run: ./gradlew dokkaHtmlMultiModule
36+
run: ./gradlew dokkaGenerate
3737

3838
- name: Deploy to gh-pages branch
3939
uses: peaceiris/actions-gh-pages@v4

build.gradle.kts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,9 @@ tasks.register("publishLibraryModules") {
2222
dependsOn(":kmp-composeuiviewcontroller-common:publishToMavenCentral")
2323
dependsOn(":kmp-composeuiviewcontroller-annotations:publishToMavenCentral")
2424
finalizedBy(":kmp-composeuiviewcontroller-ksp:publishToMavenCentral")
25+
}
26+
27+
dependencies {
28+
dokka(project(":kmp-composeuiviewcontroller-annotations"))
29+
dokka(project(":kmp-composeuiviewcontroller-gradle-plugin"))
2530
}

gradle/libs.versions.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ ksp = "2.2.20-2.0.2"
55
kotlinCompose = "1.9.0-rc01"
66
kotlinxSerialization = "1.9.0"
77
kotlinxSerializationPlugin = "2.2.20"
8-
dokka = "2.0.0"
8+
dokka = "2.1.0-Beta"
99
gradlePublish = "1.3.1"
1010
compileTesting = "0.8.0"
1111
vanniktech = "0.34.0"

kmp-composeuiviewcontroller-annotations/src/commonMain/kotlin/com/github/guilhe/kmp/composeuiviewcontroller/Annotations.kt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ import kotlin.experimental.ExperimentalObjCRefinement
44
import kotlin.native.HidesFromObjC
55

66
/**
7-
* Used to annotate the @Composable as a desired ComposeUIViewController to be used by the iOS app. While the plugin typically attempts to retrieve this name automatically, you can use this parameter to enforce a specific name if the automatic retrieval fails.
7+
* Used to annotate the `@Composable` as a desired `ComposeUIViewController` to be used by the iOS app.
8+
* The `@ComposeUIViewController` has a `frameworkBaseName` parameter to manually set the framework name. This parameter will only be used if detection fails within the Processor.
89
* [More here](https://github.com/GuilhE/KMP-ComposeUIViewController?tab=readme-ov-file#kmp-module)
910
* @param frameworkBaseName Kotlin Multiplatform library iOS targets framework base name
1011
*/
@@ -15,7 +16,7 @@ import kotlin.native.HidesFromObjC
1516
public annotation class ComposeUIViewController(val frameworkBaseName: String = "")
1617

1718
/**
18-
* Used to annotate the parameter as the composable state variable (for [advanced](https://github.com/GuilhE/KMP-ComposeUIViewController?tab=readme-ov-file#advanced) use cases). Only 0 or 1 [ComposeUIViewControllerState] and an arbitrary number of parameter types (excluding Composable functions) are allowed in [ComposeUIViewController] functions.
19+
* Used to annotate the parameter as the composable state variable (for [advanced](https://github.com/GuilhE/KMP-ComposeUIViewController?tab=readme-ov-file#advanced) use cases). Only 0 or 1 [ComposeUIViewControllerState] and an arbitrary number of parameter types (excluding `@Composable`) are allowed in [ComposeUIViewController] functions.
1920
* [More here](https://github.com/GuilhE/KMP-ComposeUIViewController?tab=readme-ov-file#kmp-module)
2021
*/
2122
@Target(AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.EXPRESSION)

kmp-composeuiviewcontroller-gradle-plugin/src/main/kotlin/com/github/guilhe/kmp/composeuiviewcontroller/gradle/ComposeUiViewControllerParameters.kt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ package com.github.guilhe.kmp.composeuiviewcontroller.gradle
77
* @property iosAppFolderName Name of the folder containing the iosApp in the root's project tree
88
* @property iosAppName Name of the iOS project (name.xcodeproj)
99
* @property targetName Name of the iOS project's target
10-
* @property exportFolderName Name of the destination folder inside iOS project ([iosAppFolderName]) where the Composable files will be copied to when [autoExport] is `true`
11-
* @property autoExport Enables auto export generated files to Xcode project. If set to false, you will find the generated files under /build/generated/ksp/. Warning: avoid deleting [iosAppFolderName]/[exportFolderName] without first using Xcode to Remove references
10+
* @property exportFolderName Name of the destination folder inside iOS project ([iosAppFolderName]) where the generated files will be copied to when
11+
* [autoExport] is `true`
12+
* @property autoExport Enables auto export generated files to Xcode project. If set to false, you will find the generated files under `/build/generated/ksp/`. Warning: avoid deleting [iosAppFolderName]/[exportFolderName] without first using Xcode to `Remove references`
1213
*/
1314
public open class ComposeUiViewControllerParameters {
1415
/**
@@ -32,7 +33,7 @@ public open class ComposeUiViewControllerParameters {
3233
public var exportFolderName: String = "Representables"
3334

3435
/**
35-
* Auto export generated files to Xcode project. If set to `false`, you will find the generated files under `/build/generated/ksp/`. Warning: avoid deleting `[iosAppFolderName]/[exportFolderName]` without first using Xcode to Remove references.
36+
* Auto export generated files to Xcode project. If set to `false`, you will find the generated files under `/build/generated/ksp/`. Warning: avoid deleting `[iosAppFolderName]/[exportFolderName]` without first using Xcode to `Remove references`.
3637
*/
3738
public var autoExport: Boolean = true
3839
}

0 commit comments

Comments
 (0)