Skip to content

Commit 0338982

Browse files
authored
andr: stop including non bd capture related dependencies in generated javadocs (#930)
* andr: stop including non bd capture related dependencies in generated javadocs * Update changelog * Update style of timbver and apollo to match modern capture UX * fix * changelog * delete
1 parent b0bfe0d commit 0338982

File tree

5 files changed

+38
-6
lines changed

5 files changed

+38
-6
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
**Fixed**
3131

32-
- Nothing yet!
32+
- Fixed an issue where 3rd-party dependencies like `androidx` were included in the released Javadoc artifacts. Also updated the style of `capture-timber` and `capture-apollo` javadocs to match.
3333

3434
### iOS
3535

MODULE.bazel

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -160,9 +160,9 @@ maven.install(
160160
"com.google.code.findbugs:jsr305:3.0.2",
161161

162162
# Dokka (javadocs generator)
163-
"org.jetbrains.dokka:analysis-kotlin-descriptors:1.9.10",
164-
"org.jetbrains.dokka:dokka-base:1.9.10",
165-
"org.jetbrains.dokka:dokka-cli:1.9.10",
163+
"org.jetbrains.dokka:analysis-kotlin-descriptors:1.9.20",
164+
"org.jetbrains.dokka:dokka-base:1.9.20",
165+
"org.jetbrains.dokka:dokka-cli:1.9.20",
166166

167167
# Library dependencies
168168
"com.google.code.gson:gson:2.10.1",

bazel/android/dokka.bzl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ def _sources_javadocs_impl(ctx):
3232
-jar $dokka_cli_jar \
3333
-pluginsClasspath $plugin_classpath \
3434
-moduleName "Capture" \
35-
-sourceSet "-src $sources_dir -noStdlibLink -noJdkLink" \
35+
-sourceSet "-src $sources_dir -noStdlibLink -noJdkLink -perPackageOptions io.bitdrift.capture.*,-suppress;.*,+suppress" \
3636
-outputDir $tmp_dir > /dev/null \
37-
-pluginsConfiguration "org.jetbrains.dokka.base.DokkaBase={\\"footerMessage\\": \\"\\u00A9 2025 bitdrift, Inc.\\", \\"separateInheritedMembers\\": true}"
37+
-pluginsConfiguration 'org.jetbrains.dokka.base.DokkaBase={"footerMessage": "© 2026 bitdrift, Inc.", "separateInheritedMembers": true}'
3838
3939
original_directory=$PWD
4040
cd $tmp_dir

platform/jvm/capture-apollo/build.gradle.kts

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,22 @@ dependencies {
6969
testImplementation(libs.kotlin.mockito.kotlin)
7070
}
7171

72+
tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>().configureEach {
73+
val dokkaBaseConfiguration = """{"footerMessage": "\u00A9 2026 bitdrift, Inc.", "separateInheritedMembers": true}"""
74+
pluginsMapConfiguration.set(mapOf("org.jetbrains.dokka.base.DokkaBase" to dokkaBaseConfiguration))
75+
76+
dokkaSourceSets.configureEach {
77+
perPackageOption {
78+
matchingRegex.set("io\\.bitdrift\\.capture\\..*")
79+
suppress.set(false)
80+
}
81+
perPackageOption {
82+
matchingRegex.set(".*")
83+
suppress.set(true)
84+
}
85+
}
86+
}
87+
7288
mavenPublishing {
7389
pom {
7490
name.set("CaptureApollo")

platform/jvm/capture-timber/build.gradle.kts

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,22 @@ dependencies {
6969
testImplementation(libs.kotlin.mockito.kotlin)
7070
}
7171

72+
tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>().configureEach {
73+
val dokkaBaseConfiguration = """{"footerMessage": "\u00A9 2026 bitdrift, Inc.", "separateInheritedMembers": true}"""
74+
pluginsMapConfiguration.set(mapOf("org.jetbrains.dokka.base.DokkaBase" to dokkaBaseConfiguration))
75+
76+
dokkaSourceSets.configureEach {
77+
perPackageOption {
78+
matchingRegex.set("io\\.bitdrift\\.capture\\..*")
79+
suppress.set(false)
80+
}
81+
perPackageOption {
82+
matchingRegex.set(".*")
83+
suppress.set(true)
84+
}
85+
}
86+
}
87+
7288
mavenPublishing {
7389
pom {
7490
name.set("CaptureTimber")

0 commit comments

Comments
 (0)