Skip to content

Commit 584ae3d

Browse files
elizarovelizarov
committed
Cross-module linking via Dokka
1 parent 5d273a9 commit 584ae3d

File tree

14 files changed

+198
-17
lines changed

14 files changed

+198
-17
lines changed

‎integration/kotlinx-coroutines-guava/pom.xml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,26 @@
3131
<build>
3232
<sourceDirectory>src/main/kotlin</sourceDirectory>
3333
<testSourceDirectory>src/test/kotlin</testSourceDirectory>
34+
35+
<plugins>
36+
<plugin>
37+
<groupId>org.jetbrains.dokka</groupId>
38+
<artifactId>dokka-maven-plugin</artifactId>
39+
<version>${dokka.version}</version>
40+
<configuration>
41+
<externalDocumentationLinks combine.children="append">
42+
<link>
43+
<url>${core.docs.url}</url>
44+
<packageListUrl>file:///${project.parent.basedir}/kotlinx-coroutines-core/target/dokka/kotlinx-coroutines-core/package-list</packageListUrl>
45+
</link>
46+
<link>
47+
<url>https://google.github.io/guava/releases/18.0/api/docs/</url>
48+
</link>
49+
</externalDocumentationLinks>
50+
<skip>false</skip>
51+
</configuration>
52+
</plugin>
53+
</plugins>
3454
</build>
3555

3656
<dependencies>

‎integration/kotlinx-coroutines-jdk8/pom.xml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,23 @@
3131
<build>
3232
<sourceDirectory>src/main/kotlin</sourceDirectory>
3333
<testSourceDirectory>src/test/kotlin</testSourceDirectory>
34+
35+
<plugins>
36+
<plugin>
37+
<groupId>org.jetbrains.dokka</groupId>
38+
<artifactId>dokka-maven-plugin</artifactId>
39+
<version>${dokka.version}</version>
40+
<configuration>
41+
<externalDocumentationLinks combine.children="append">
42+
<link>
43+
<url>${core.docs.url}</url>
44+
<packageListUrl>file:///${project.parent.basedir}/kotlinx-coroutines-core/target/dokka/kotlinx-coroutines-core/package-list</packageListUrl>
45+
</link>
46+
</externalDocumentationLinks>
47+
<skip>false</skip>
48+
</configuration>
49+
</plugin>
50+
</plugins>
3451
</build>
3552

3653
<dependencies>

‎integration/kotlinx-coroutines-nio/pom.xml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,23 @@
3232
<build>
3333
<sourceDirectory>src/main/kotlin</sourceDirectory>
3434
<testSourceDirectory>src/test/kotlin</testSourceDirectory>
35+
36+
<plugins>
37+
<plugin>
38+
<groupId>org.jetbrains.dokka</groupId>
39+
<artifactId>dokka-maven-plugin</artifactId>
40+
<version>${dokka.version}</version>
41+
<configuration>
42+
<externalDocumentationLinks combine.children="append">
43+
<link>
44+
<url>${core.docs.url}</url>
45+
<packageListUrl>file:///${project.parent.basedir}/kotlinx-coroutines-core/target/dokka/kotlinx-coroutines-core/package-list</packageListUrl>
46+
</link>
47+
</externalDocumentationLinks>
48+
<skip>false</skip>
49+
</configuration>
50+
</plugin>
51+
</plugins>
3552
</build>
3653

3754
<dependencies>

‎knit/pom.xml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,6 @@
3535
</resource>
3636
</resources>
3737
<plugins>
38-
<!-- skip dokka for this module -->
39-
<plugin>
40-
<groupId>org.jetbrains.dokka</groupId>
41-
<artifactId>dokka-maven-plugin</artifactId>
42-
<version>${dokka.version}</version>
43-
<configuration>
44-
<skip>true</skip>
45-
</configuration>
46-
</plugin>
4738
<!-- do not deploy this module -->
4839
<plugin>
4940
<artifactId>maven-deploy-plugin</artifactId>

‎kotlinx-coroutines-core/pom.xml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,14 @@
5656
</execution>
5757
</executions>
5858
</plugin>
59+
<plugin>
60+
<groupId>org.jetbrains.dokka</groupId>
61+
<artifactId>dokka-maven-plugin</artifactId>
62+
<version>${dokka.version}</version>
63+
<configuration>
64+
<skip>false</skip>
65+
</configuration>
66+
</plugin>
5967
</plugins>
6068
</build>
6169
</project>

‎pom.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
<junit.version>4.12</junit.version>
4747
<maven.compiler.source>1.6</maven.compiler.source>
4848
<maven.compiler.target>1.6</maven.compiler.target>
49+
<core.docs.url>https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/</core.docs.url>
4950
</properties>
5051

5152
<prerequisites>
@@ -195,6 +196,7 @@
195196
</includes>
196197
<outputFormat>kotlin-website</outputFormat>
197198
<jdkVersion>8</jdkVersion>
199+
<skip>true</skip> <!-- children override -->
198200
</configuration>
199201
</plugin>
200202
<plugin>

‎reactive/kotlinx-coroutines-reactive/pom.xml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,26 @@
3232
<build>
3333
<sourceDirectory>src/main/kotlin</sourceDirectory>
3434
<testSourceDirectory>src/test/kotlin</testSourceDirectory>
35+
36+
<plugins>
37+
<plugin>
38+
<groupId>org.jetbrains.dokka</groupId>
39+
<artifactId>dokka-maven-plugin</artifactId>
40+
<version>${dokka.version}</version>
41+
<configuration>
42+
<externalDocumentationLinks combine.children="append">
43+
<link>
44+
<url>${core.docs.url}</url>
45+
<packageListUrl>file:///${project.parent.basedir}/kotlinx-coroutines-core/target/dokka/kotlinx-coroutines-core/package-list</packageListUrl>
46+
</link>
47+
<link>
48+
<url>http://www.reactive-streams.org/reactive-streams-1.0.0-javadoc/</url>
49+
</link>
50+
</externalDocumentationLinks>
51+
<skip>false</skip>
52+
</configuration>
53+
</plugin>
54+
</plugins>
3555
</build>
3656

3757
<dependencies>

‎reactive/kotlinx-coroutines-reactor/pom.xml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,26 @@
3333
<build>
3434
<sourceDirectory>src/main/kotlin</sourceDirectory>
3535
<testSourceDirectory>src/test/kotlin</testSourceDirectory>
36+
37+
<plugins>
38+
<plugin>
39+
<groupId>org.jetbrains.dokka</groupId>
40+
<artifactId>dokka-maven-plugin</artifactId>
41+
<version>${dokka.version}</version>
42+
<configuration>
43+
<externalDocumentationLinks combine.children="append">
44+
<link>
45+
<url>${core.docs.url}</url>
46+
<packageListUrl>file:///${project.parent.basedir}/kotlinx-coroutines-core/target/dokka/kotlinx-coroutines-core/package-list</packageListUrl>
47+
</link>
48+
<link>
49+
<url>https://projectreactor.io/docs/core/release/api/</url>
50+
</link>
51+
</externalDocumentationLinks>
52+
<skip>false</skip>
53+
</configuration>
54+
</plugin>
55+
</plugins>
3656
</build>
3757

3858
<dependencyManagement>

‎reactive/kotlinx-coroutines-rx1/pom.xml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,26 @@
3232
<build>
3333
<sourceDirectory>src/main/kotlin</sourceDirectory>
3434
<testSourceDirectory>src/test/kotlin</testSourceDirectory>
35+
36+
<plugins>
37+
<plugin>
38+
<groupId>org.jetbrains.dokka</groupId>
39+
<artifactId>dokka-maven-plugin</artifactId>
40+
<version>${dokka.version}</version>
41+
<configuration>
42+
<externalDocumentationLinks combine.children="append">
43+
<link>
44+
<url>${core.docs.url}</url>
45+
<packageListUrl>file:///${project.parent.basedir}/kotlinx-coroutines-core/target/dokka/kotlinx-coroutines-core/package-list</packageListUrl>
46+
</link>
47+
<link>
48+
<url>http://reactivex.io/RxJava/1.x/javadoc/</url>
49+
</link>
50+
</externalDocumentationLinks>
51+
<skip>false</skip>
52+
</configuration>
53+
</plugin>
54+
</plugins>
3555
</build>
3656

3757
<dependencies>

‎reactive/kotlinx-coroutines-rx2/pom.xml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,26 @@
3232
<build>
3333
<sourceDirectory>src/main/kotlin</sourceDirectory>
3434
<testSourceDirectory>src/test/kotlin</testSourceDirectory>
35+
36+
<plugins>
37+
<plugin>
38+
<groupId>org.jetbrains.dokka</groupId>
39+
<artifactId>dokka-maven-plugin</artifactId>
40+
<version>${dokka.version}</version>
41+
<configuration>
42+
<externalDocumentationLinks combine.children="append">
43+
<link>
44+
<url>${core.docs.url}</url>
45+
<packageListUrl>file:///${project.parent.basedir}/kotlinx-coroutines-core/target/dokka/kotlinx-coroutines-core/package-list</packageListUrl>
46+
</link>
47+
<link>
48+
<url>http://reactivex.io/RxJava/javadoc/</url>
49+
</link>
50+
</externalDocumentationLinks>
51+
<skip>false</skip>
52+
</configuration>
53+
</plugin>
54+
</plugins>
3555
</build>
3656

3757
<dependencies>

0 commit comments

Comments
 (0)