Skip to content

Commit 8f204ef

Browse files
authored
Cleanup API docs setup (#5928)
Remove old TODO, unnecessary trait and obsolete special case. Pull request: #5928
1 parent 2f07969 commit 8f204ef

File tree

3 files changed

+12
-10
lines changed

3 files changed

+12
-10
lines changed

libs/kotlinlib/package.mill

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ import mill.contrib.buildinfo.BuildInfo
66
import mill.scalalib.*
77
import millbuild.*
88

9-
// TODO change MillPublishScalaModule to MillStableScalaModule after mill version with kotlinlib is released,
10-
// because currently there is no previous artifact version
119
object `package` extends MillStableScalaModule with BuildInfo {
1210

1311
def moduleDeps = Seq(build.libs.javalib, build.libs.javalib.testrunner, api, `ksp2-api`)
@@ -39,18 +37,16 @@ object `package` extends MillStableScalaModule with BuildInfo {
3937
)
4038
)
4139

42-
trait MillKotlinModule extends MillPublishScalaModule
43-
4440
// shared between kotlinlib and kotlinlib.worker
45-
object api extends MillKotlinModule {
41+
object api extends MillPublishScalaModule {
4642
def moduleDeps = Seq(build.libs.javalib.testrunner)
4743

4844
override def compileMvnDeps: T[Seq[Dep]] = Seq(
4945
Deps.osLib
5046
)
5147
}
5248

53-
object worker extends MillKotlinModule {
49+
object worker extends MillPublishScalaModule {
5450
override def compileModuleDeps = Seq(api)
5551

5652
def mandatoryMvnDeps = Seq.empty[Dep]
@@ -63,9 +59,9 @@ object `package` extends MillStableScalaModule with BuildInfo {
6359
)
6460
}
6561

66-
object `ksp2-api` extends MillKotlinModule
62+
object `ksp2-api` extends MillPublishScalaModule
6763

68-
object ksp2 extends MillKotlinModule {
64+
object ksp2 extends MillPublishScalaModule {
6965
def moduleDeps = Seq(`ksp2-api`)
7066
override def compileMvnDeps: T[Seq[Dep]] = super.compileMvnDeps() ++ Seq(
7167
mvn"com.google.devtools.ksp:symbol-processing-common-deps:${Deps.kotlinVersion}-${Deps.kspVersion}",
Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
package millbuild
22
import mill._, scalalib._
33

4-
/** Publishable module which contains strictly handled API. */
4+
/**
5+
* Publishable module which contains strictly handled API.
6+
* Those modules are also included in the generated API documentation.
7+
*/
58
trait MillStableScalaModule extends MillPublishScalaModule with MillStableJavaModule

website/package.mill

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ import mill.api.BuildCtx
1111

1212
/** Generates the mill documentation with Antora. */
1313
object `package` extends mill.Module {
14+
15+
/**
16+
* API documentation generated with ScalaDoc.
17+
*/
1418
object apidocs extends UnidocModule {
1519
def unidocDocumentTitle = Task { "Mill" }
1620

@@ -25,7 +29,6 @@ object `package` extends mill.Module {
2529
def scalaVersion = Deps.scalaVersion
2630
def moduleDeps = build.moduleInternal.modules.collect {
2731
case m: MillStableScalaModule => m
28-
case m: JavaModule if m eq build.libs.kotlinlib => m
2932
}
3033
def unidocSourceUrl = Task {
3134
val sha = "main" // VcsVersion.vcsState().currentRevision

0 commit comments

Comments
 (0)