File tree Expand file tree Collapse file tree 4 files changed +43
-4
lines changed
src/commonMain/kotlin/org/foo
maven/dokka-maven-example Expand file tree Collapse file tree 4 files changed +43
-4
lines changed Original file line number Diff line number Diff line change 1+ # kotlinant
2+
3+ Example configuration using Ant for Dokka.
4+
5+ 1 . Install Ant.
6+ 2 . Set path to Dokka's fatjar in build.xml.
7+ 3 . Run in console:
8+ ```
9+ ant document
10+ ```
11+ your documentation will be located at ` ant/dokka-ant/doc ` .
12+
13+ To clean, run:
14+ ```
15+ ant clean
16+ ```
Original file line number Diff line number Diff line change 1+ <project default =" document" >
2+ <target name =" clean" >
3+ <delete dir =" doc" />
4+ </target >
5+ <typedef resource =" dokka-antlib.xml" classpath =" /path/to/fatjar/dokka-fatjar-0.9.19.jar" />
6+ <target name =" document" >
7+ <dokka format =" javadoc" outputdir =" doc" >
8+ <passConfig src =" src" moduleName =" dokka-ant" />
9+ </dokka >
10+ </target >
11+ </project >
Original file line number Diff line number Diff line change 1+ package commonMain.kotlin.org.foo
2+
3+
4+ /* *
5+ * just foo class
6+ */
7+ class Foo {
8+
9+ fun bar (): Int = 0
10+ }
Original file line number Diff line number Diff line change 99 <version >1.0-SNAPSHOT</version >
1010 <properties >
1111 <kotlin .version>1.0.3</kotlin .version>
12- <dokka .version>0.9.9 </dokka .version>
12+ <dokka .version>0.9.19 </dokka .version>
1313 </properties >
1414
1515 <dependencies >
4141 <execution >
4242 <id >test-compile</id >
4343 <phase >test-compile</phase >
44- <goals > <goal >test-compile</goal > </goals >
44+ <goals >
45+ <goal >test-compile</goal >
46+ </goals >
4547 </execution >
4648 </executions >
4749 </plugin >
6567 </includes >
6668 <sourceLinks >
6769 <link >
68- <dir >${project.basedir} </dir >
70+ <path >${project.basedir} </path >
6971 <url >https://github.com/JetBrains/kotlin-examples/blob/master/maven/dokka-maven-example</url >
70- <urlSuffix >#L</urlSuffix >
72+ <lineSuffix >#L</lineSuffix >
7173 </link >
7274 </sourceLinks >
7375 </configuration >
You can’t perform that action at this time.
0 commit comments