Add dokka multiplatform example

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

@@ -0,0 +1,90 @@
+import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType
+
+buildscript {
+    repositories {
+        jcenter()
+        mavenLocal()
+    }
+    dependencies {
+        classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.9.19-SNAPSHOT"
+    }
+}
+
+plugins {
+    id 'org.jetbrains.kotlin.multiplatform' version '1.3.50'
+}
+
+repositories {
+    jcenter()
+    mavenLocal()
+}
+
+group 'org.test'
+version '1.0-SNAPSHOT'
+
+kotlin {
+    jvm() // Create a JVM target with the default name 'jvm'
+    js()
+    sourceSets {
+        commonMain {
+            dependencies {
+                implementation kotlin('stdlib-common')
+            }
+        }
+        jsMain {
+            dependencies{
+                implementation "org.jetbrains.kotlin:kotlin-stdlib-js"
+            }
+        }
+        jvmMain {
+            dependencies {
+                implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.0-M2")
+                implementation kotlin('stdlib-jdk8')
+            }
+        }
+    }
+}
+
+
+
+apply plugin: 'org.jetbrains.dokka'
+
+afterEvaluate { // configuration in afterEvaluate, because we want to manually extract the classpath
+                // from the kotlin-multiplatform plugin after its configuration (in `customName` closure)
+    dokka {
+        outputDirectory = "$buildDir/dokka"
+        outputFormat = "html"
+
+        multiplatform {
+            js {} // this platform uses autoconfiguration. Sources are fetched from kotlin-multiplatform plugin
+
+            customName { // the name is different than `jvm` in Kotlin plugin, so
+                // sourceRoots, classpath, platform and targets must be passed explicitly
+                targets = ["JVM"]
+                platform = "jvm"
+                sourceRoot {
+                    path = kotlin.sourceSets.getByName("jvmMain").kotlin.srcDirs.first().toString()
+                }
+                sourceRoot {
+                    path = kotlin.sourceSets.getByName("commonMain").kotlin.srcDirs.first().toString()
+                }
+                classpath = kotlin.targets
+                        .findAll { it.platformType == KotlinPlatformType.common || it.platformType == KotlinPlatformType.jvm }
+                        .collect { target ->
+                            target.compilations.getByName("main").compileDependencyFiles.files.collect { it.path }
+                        }
+                        .flatten()
+            }
+
+            common {} // this platform uses autoconfiguration
+
+            global {  // this is a special block for passing perPackageOptions,
+                // externalDocumentationLinks and sourceLinks to all other platforms
+                perPackageOption { // suppress a package on all platforms
+                    prefix = "shouldbesuppressed"
+                    suppress = true
+                }
+            }
+        }
+    }
+}

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

@@ -0,0 +1,75 @@
+import org.jetbrains.dokka.gradle.DokkaTask
+import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType
+
+
+plugins {
+    kotlin("multiplatform") version "1.3.50"
+    id("org.jetbrains.dokka") version "0.9.19-SNAPSHOT"
+}
+
+repositories {
+    jcenter()
+    mavenLocal()
+}
+
+group = "org.test"
+version = "1.0-SNAPSHOT"
+
+kotlin {
+    jvm() // Create a JVM target with the default name "jvm"
+    js()
+    sourceSets {
+        val commonMain by getting {
+            dependencies {
+                implementation(kotlin("stdlib-common"))
+            }
+        }
+        val jsMain by getting {
+            dependencies{
+                implementation("org.jetbrains.kotlin:kotlin-stdlib-js")
+            }
+        }
+        val jvmMain by getting {
+            dependencies {
+                implementation(kotlin("stdlib-jdk8"))
+                implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.0-RC2")
+            }
+        }
+    }
+}
+
+tasks {
+    val dokka by getting(DokkaTask::class) {
+        outputDirectory = "$buildDir/dokka"
+        outputFormat = "html"
+
+        multiplatform {
+            val js by creating {} // this platform uses autoconfiguration. Sources are fetched from kotlin-multiplatform plugin
+
+            register("customName") { // or `val customName by creating {}`. The name is different than `jvm` in Kotlin plugin, so
+                                           // sourceRoots, classpath, platform and targets must be passed explicitly
+                targets = listOf("JVM")
+                platform = "jvm"
+                sourceRoot {
+                    path = kotlin.sourceSets.getByName("jvmMain").kotlin.srcDirs.first().toString()
+                }
+                sourceRoot {
+                    path = kotlin.sourceSets.getByName("commonMain").kotlin.srcDirs.first().toString()
+                }
+                classpath = kotlin.targets
+                    .filter { it.platformType == KotlinPlatformType.common || it.platformType == KotlinPlatformType.jvm }
+                    .flatMap { it.compilations.getByName("main").compileDependencyFiles.files.map { it.path } }
+            }
+
+            register("common") {} // or `val common by creating {}`, this platform uses autoconfiguration
+
+            register("global") {  // or `val global by creating {}`, this is a special block for passing perPackageOptions,
+                                        // externalDocumentationLinks and sourceLinks to all other platforms
+                perPackageOption { // suppress a package on all platforms
+                    prefix = "shouldbesuppressed"
+                    suppress = true
+                }
+            }
+        }
+    }
+}

gradle/dokka-multiplatform-example/gradle.properties

@@ -0,0 +1 @@
+kotlin.code.style=official

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

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.3-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

gradle/dokka-multiplatform-example/gradlew

@@ -0,0 +1,172 @@
+#!/usr/bin/env sh
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS=""
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin, switch paths to Windows format before running java
+if $cygwin ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=$((i+1))
+    done
+    case $i in
+        (0) set -- ;;
+        (1) set -- "$args0" ;;
+        (2) set -- "$args0" "$args1" ;;
+        (3) set -- "$args0" "$args1" "$args2" ;;
+        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=$(save "$@")
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+  cd "$(dirname "$0")"
+fi
+
+exec "$JAVACMD" "$@"