Minor: prepare for documentation generation

This commit is contained in:
Simon Ogorodnik
2017-05-05 20:20:19 +03:00
committed by Simon Ogorodnik
parent 775eeb75c9
commit a19e229a72
+42 -13
View File
@@ -2,9 +2,10 @@
<!-- Generates the standard library documentation using Dokka. -->
<property name="github.revision" value="master"/>
<property name="dokka.path" value="../dependencies/dokka" />
<property name="js.stdlib.src.path" value="../dependencies/js-stdlib-src" />
<property name="docs.output" value="${basedir}/doc" />
<property name="dokka.format" value="kotlin-website-samples"/>
<property name="dokka.format" value="kotlin-website-html"/>
<property name="js.stdlib.common.src.path" value="stdlib/js/build/common-sources"/>
<typedef resource="dokka-antlib.xml">
<classpath>
@@ -22,40 +23,68 @@
<mkdir dir="${docs.output}"/>
</target>
<target name="build-js-stdlib-sources">
<ant antfile="build.xml" target="pack-js-stdlib-sources" dir=".."/>
<delete dir="${js.stdlib.src.path}"/>
<unzip src="../dist/kotlinc/lib/kotlin-stdlib-js-sources.jar" dest="${js.stdlib.src.path}"/>
<target name="preprocess-js-common">
<java classname="org.gradle.wrapper.GradleWrapperMain"
fork="true"
dir="${basedir}"
failonerror="true"
timeout="4000000"
maxmemory="400m"
taskname="gradle">
<classpath>
<pathelement location="${basedir}/gradle/wrapper/gradle-wrapper.jar"/>
</classpath>
<arg line="--no-daemon"/>
<arg line=":kotlin-stdlib-js:preprocessSourcesMain"/>
</java>
</target>
<target name="document" depends="clean,build-js-stdlib-sources">
<target name="document" depends="clean,preprocess-js-common">
<dokka samples="stdlib/samples/test" outputDir="${docs.output}/jre8" moduleName="kotlin-stdlib" skipDeprecated="true" outputFormat="${dokka.format}" jdkversion="8" impliedplatforms="JVM,JS"
include="stdlib/src/Module.md">
include="stdlib/src/Module.md" noStdlibLink="true">
<sourceRoot path="stdlib/src" platforms="JVM"/>
<sourceRoot path="stdlib/jre7/src" platforms="JVM,JRE7"/>
<sourceRoot path="stdlib/jre8/src" platforms="JVM,JRE8"/>
<sourceRoot path="../core/builtins" platforms="JVM"/>
<sourceRoot path="../core/reflection.jvm" platforms="JVM"/>
<sourceRoot path="../core/runtime.jvm/src/kotlin" platforms="JVM"/>
<sourceRoot path="../core/runtime.jvm/src/kotlin/jvm/annotations" platforms="JVM"/>
<sourceRoot path="../core/runtime.jvm/src/kotlin/jvm/JvmClassMapping.kt" platforms="JVM"/>
<sourceRoot path="../core/runtime.jvm/src/kotlin/jvm/PurelyImplements.kt" platforms="JVM"/>
<sourceRoot path="../core/runtime.jvm/src/kotlin/TypeAliases.kt" platforms="JVM"/>
<sourceRoot path="../core/runtime.jvm/src/kotlin/text/TypeAliases.kt" platforms="JVM"/>
<sourceRoot path="../core/builtins" platforms="JS"/>
<sourceRoot path="${js.stdlib.src.path}" platforms="JS"/>
<sourceRoot path="../js/js.libraries/src/browser" platforms="JS"/>
<sourceRoot path="../js/js.libraries/src/core" platforms="JS"/>
<sourceRoot path="../js/js.libraries/src/dom" platforms="JS"/>
<sourceRoot path="../js/js.libraries/src/generated" platforms="JS"/>
<sourceRoot path="../js/js.libraries/src/js" platforms="JS"/>
<sourceRoot path="../js/js.libraries/src/reflect" platforms="JS"/>
<sourceRoot path="${js.stdlib.common.src.path}" platforms="JS"/>
<sourcelink path=".." url="http://github.com/JetBrains/kotlin/blob/${github.revision}" linesuffix="#L"/>
</dokka>
<dokka outputDir="${docs.output}/jre8" moduleName="kotlin-test" skipDeprecated="true" outputFormat="${dokka.format}" jdkversion="8" impliedplatforms="JVM,JS">
<dokka outputDir="${docs.output}/jre8" moduleName="kotlin-test" skipDeprecated="true" outputFormat="${dokka.format}" jdkversion="8" impliedplatforms="JVM,JS"
noStdlibLink="true">
<sourceRoot path="kotlin.test/common/src/main/kotlin" platforms="JVM,JS"/>
<sourceRoot path="kotlin.test/jvm/src/main/kotlin" platforms="JVM"/>
<sourceRoot path="kotlin.test/js/src/main/kotlin" platforms="JS"/>
<sourcelink path=".." url="http://github.com/JetBrains/kotlin/blob/${github.revision}" linesuffix="#L"/>
<ExternalDocumentationLink url="https://kotlinlang.org/api/latest/jvm/stdlib/" packageListUrl="file://${docs.output}/jre8/kotlin-stdlib/package-list" />
</dokka>
</target>
<target name="zip" depends="document">
<target name="write-build-number">
<echo file="${docs.output}/jre8/kotlin-stdlib/buildNumber.txt">${build.number}</echo>
<echo file="${docs.output}/jre8/kotlin-test/buildNumber.txt">${build.number}</echo>
</target>
<target name="zip" depends="document,write-build-number">
<zip destfile="target/stdlib-docs.zip" basedir="${docs.output}/jre8/kotlin-stdlib"/>
<zip destfile="target/kotlin-test-docs.zip" basedir="${docs.output}/jre8/kotlin-test"/>
</target>