Skip to content
This repository was archived by the owner on Jan 22, 2024. It is now read-only.

Commit 1533216

Browse files
kamildoleglokamildoleglo
committed
Add dokka multiplatform example
1 parent d7f388a commit 1533216

File tree

15 files changed

+533
-0
lines changed

15 files changed

+533
-0
lines changed

‎gradle/dokka-multiplatform-example/alternative.build.gradle

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType
2+
3+
buildscript {
4+
repositories {
5+
jcenter()
6+
mavenLocal()
7+
}
8+
dependencies {
9+
classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.9.19-SNAPSHOT"
10+
}
11+
}
12+
13+
plugins {
14+
id 'org.jetbrains.kotlin.multiplatform' version '1.3.50'
15+
}
16+
17+
repositories {
18+
jcenter()
19+
mavenLocal()
20+
}
21+
22+
group 'org.test'
23+
version '1.0-SNAPSHOT'
24+
25+
kotlin {
26+
jvm() // Create a JVM target with the default name 'jvm'
27+
js()
28+
sourceSets {
29+
commonMain {
30+
dependencies {
31+
implementation kotlin('stdlib-common')
32+
}
33+
}
34+
jsMain {
35+
dependencies{
36+
implementation "org.jetbrains.kotlin:kotlin-stdlib-js"
37+
}
38+
}
39+
jvmMain {
40+
dependencies {
41+
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.0-M2")
42+
implementation kotlin('stdlib-jdk8')
43+
}
44+
}
45+
}
46+
}
47+
48+
49+
50+
apply plugin: 'org.jetbrains.dokka'
51+
52+
afterEvaluate { // configuration in afterEvaluate, because we want to manually extract the classpath
53+
// from the kotlin-multiplatform plugin after its configuration (in `customName` closure)
54+
dokka {
55+
outputDirectory = "$buildDir/dokka"
56+
outputFormat = "html"
57+
58+
multiplatform {
59+
js {} // this platform uses autoconfiguration. Sources are fetched from kotlin-multiplatform plugin
60+
61+
customName { // the name is different than `jvm` in Kotlin plugin, so
62+
// sourceRoots, classpath, platform and targets must be passed explicitly
63+
targets = ["JVM"]
64+
platform = "jvm"
65+
sourceRoot {
66+
path = kotlin.sourceSets.getByName("jvmMain").kotlin.srcDirs.first().toString()
67+
}
68+
sourceRoot {
69+
path = kotlin.sourceSets.getByName("commonMain").kotlin.srcDirs.first().toString()
70+
}
71+
classpath = kotlin.targets
72+
.findAll { it.platformType == KotlinPlatformType.common || it.platformType == KotlinPlatformType.jvm }
73+
.collect { target ->
74+
target.compilations.getByName("main").compileDependencyFiles.files.collect { it.path }
75+
}
76+
.flatten()
77+
}
78+
79+
common {} // this platform uses autoconfiguration
80+
81+
global { // this is a special block for passing perPackageOptions,
82+
// externalDocumentationLinks and sourceLinks to all other platforms
83+
perPackageOption { // suppress a package on all platforms
84+
prefix = "shouldbesuppressed"
85+
suppress = true
86+
}
87+
}
88+
}
89+
}
90+
}

‎gradle/dokka-multiplatform-example/build.gradle.kts

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
import org.jetbrains.dokka.gradle.DokkaTask
2+
import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType
3+
4+
5+
plugins {
6+
kotlin("multiplatform") version "1.3.50"
7+
id("org.jetbrains.dokka") version "0.9.19-SNAPSHOT"
8+
}
9+
10+
repositories {
11+
jcenter()
12+
mavenLocal()
13+
}
14+
15+
group = "org.test"
16+
version = "1.0-SNAPSHOT"
17+
18+
kotlin {
19+
jvm() // Create a JVM target with the default name "jvm"
20+
js()
21+
sourceSets {
22+
val commonMain by getting {
23+
dependencies {
24+
implementation(kotlin("stdlib-common"))
25+
}
26+
}
27+
val jsMain by getting {
28+
dependencies{
29+
implementation("org.jetbrains.kotlin:kotlin-stdlib-js")
30+
}
31+
}
32+
val jvmMain by getting {
33+
dependencies {
34+
implementation(kotlin("stdlib-jdk8"))
35+
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.0-RC2")
36+
}
37+
}
38+
}
39+
}
40+
41+
tasks {
42+
val dokka by getting(DokkaTask::class) {
43+
outputDirectory = "$buildDir/dokka"
44+
outputFormat = "html"
45+
46+
multiplatform {
47+
val js by creating {} // this platform uses autoconfiguration. Sources are fetched from kotlin-multiplatform plugin
48+
49+
register("customName") { // or `val customName by creating {}`. The name is different than `jvm` in Kotlin plugin, so
50+
// sourceRoots, classpath, platform and targets must be passed explicitly
51+
targets = listOf("JVM")
52+
platform = "jvm"
53+
sourceRoot {
54+
path = kotlin.sourceSets.getByName("jvmMain").kotlin.srcDirs.first().toString()
55+
}
56+
sourceRoot {
57+
path = kotlin.sourceSets.getByName("commonMain").kotlin.srcDirs.first().toString()
58+
}
59+
classpath = kotlin.targets
60+
.filter { it.platformType == KotlinPlatformType.common || it.platformType == KotlinPlatformType.jvm }
61+
.flatMap { it.compilations.getByName("main").compileDependencyFiles.files.map { it.path } }
62+
}
63+
64+
register("common") {} // or `val common by creating {}`, this platform uses autoconfiguration
65+
66+
register("global") { // or `val global by creating {}`, this is a special block for passing perPackageOptions,
67+
// externalDocumentationLinks and sourceLinks to all other platforms
68+
perPackageOption { // suppress a package on all platforms
69+
prefix = "shouldbesuppressed"
70+
suppress = true
71+
}
72+
}
73+
}
74+
}
75+
}

‎gradle/dokka-multiplatform-example/gradle.properties

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
kotlin.code.style=official

‎gradle/dokka-multiplatform-example/gradle/wrapper/gradle-wrapper.jar

54.9 KB
Binary file not shown.

‎gradle/dokka-multiplatform-example/gradle/wrapper/gradle-wrapper.properties

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.3-bin.zip
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists

‎gradle/dokka-multiplatform-example/gradlew

+172
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
#!/usr/bin/env sh
2+
3+
##############################################################################
4+
##
5+
## Gradle start up script for UN*X
6+
##
7+
##############################################################################
8+
9+
# Attempt to set APP_HOME
10+
# Resolve links: $0 may be a link
11+
PRG="$0"
12+
# Need this for relative symlinks.
13+
while [ -h "$PRG" ] ; do
14+
ls=`ls -ld "$PRG"`
15+
link=`expr "$ls" : '.*-> \(.*\)$'`
16+
if expr "$link" : '/.*' > /dev/null; then
17+
PRG="$link"
18+
else
19+
PRG=`dirname "$PRG"`"/$link"
20+
fi
21+
done
22+
SAVED="`pwd`"
23+
cd "`dirname \"$PRG\"`/" >/dev/null
24+
APP_HOME="`pwd -P`"
25+
cd "$SAVED" >/dev/null
26+
27+
APP_NAME="Gradle"
28+
APP_BASE_NAME=`basename "$0"`
29+
30+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31+
DEFAULT_JVM_OPTS=""
32+
33+
# Use the maximum available, or set MAX_FD != -1 to use that value.
34+
MAX_FD="maximum"
35+
36+
warn () {
37+
echo "$*"
38+
}
39+
40+
die () {
41+
echo
42+
echo "$*"
43+
echo
44+
exit 1
45+
}
46+
47+
# OS specific support (must be 'true' or 'false').
48+
cygwin=false
49+
msys=false
50+
darwin=false
51+
nonstop=false
52+
case "`uname`" in
53+
CYGWIN* )
54+
cygwin=true
55+
;;
56+
Darwin* )
57+
darwin=true
58+
;;
59+
MINGW* )
60+
msys=true
61+
;;
62+
NONSTOP* )
63+
nonstop=true
64+
;;
65+
esac
66+
67+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68+
69+
# Determine the Java command to use to start the JVM.
70+
if [ -n "$JAVA_HOME" ] ; then
71+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72+
# IBM's JDK on AIX uses strange locations for the executables
73+
JAVACMD="$JAVA_HOME/jre/sh/java"
74+
else
75+
JAVACMD="$JAVA_HOME/bin/java"
76+
fi
77+
if [ ! -x "$JAVACMD" ] ; then
78+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79+
80+
Please set the JAVA_HOME variable in your environment to match the
81+
location of your Java installation."
82+
fi
83+
else
84+
JAVACMD="java"
85+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86+
87+
Please set the JAVA_HOME variable in your environment to match the
88+
location of your Java installation."
89+
fi
90+
91+
# Increase the maximum file descriptors if we can.
92+
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93+
MAX_FD_LIMIT=`ulimit -H -n`
94+
if [ $? -eq 0 ] ; then
95+
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96+
MAX_FD="$MAX_FD_LIMIT"
97+
fi
98+
ulimit -n $MAX_FD
99+
if [ $? -ne 0 ] ; then
100+
warn "Could not set maximum file descriptor limit: $MAX_FD"
101+
fi
102+
else
103+
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104+
fi
105+
fi
106+
107+
# For Darwin, add options to specify how the application appears in the dock
108+
if $darwin; then
109+
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110+
fi
111+
112+
# For Cygwin, switch paths to Windows format before running java
113+
if $cygwin ; then
114+
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115+
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116+
JAVACMD=`cygpath --unix "$JAVACMD"`
117+
118+
# We build the pattern for arguments to be converted via cygpath
119+
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120+
SEP=""
121+
for dir in $ROOTDIRSRAW ; do
122+
ROOTDIRS="$ROOTDIRS$SEP$dir"
123+
SEP="|"
124+
done
125+
OURCYGPATTERN="(^($ROOTDIRS))"
126+
# Add a user-defined pattern to the cygpath arguments
127+
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128+
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129+
fi
130+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
131+
i=0
132+
for arg in "$@" ; do
133+
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134+
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135+
136+
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137+
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138+
else
139+
eval `echo args$i`="\"$arg\""
140+
fi
141+
i=$((i+1))
142+
done
143+
case $i in
144+
(0) set -- ;;
145+
(1) set -- "$args0" ;;
146+
(2) set -- "$args0" "$args1" ;;
147+
(3) set -- "$args0" "$args1" "$args2" ;;
148+
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149+
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150+
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151+
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152+
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153+
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154+
esac
155+
fi
156+
157+
# Escape application args
158+
save () {
159+
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160+
echo " "
161+
}
162+
APP_ARGS=$(save "$@")
163+
164+
# Collect all arguments for the java command, following the shell quoting and substitution rules
165+
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166+
167+
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168+
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169+
cd "$(dirname "$0")"
170+
fi
171+
172+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)