Skip to content

Commit 6e70d04

Browse files
authored
Merge pull request Kotlin#110 from KrystianUjma/add-ant-example-update-dokka-maven-example
add ant example, update dokka maven example
2 parents 64e6cf9 + 170d34c commit 6e70d04

File tree

4 files changed

+43
-4
lines changed

4 files changed

+43
-4
lines changed

ant/dokka-ant/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
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+
```

ant/dokka-ant/build.xml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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>
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
package commonMain.kotlin.org.foo
2+
3+
4+
/**
5+
* just foo class
6+
*/
7+
class Foo {
8+
9+
fun bar(): Int = 0
10+
}

maven/dokka-maven-example/pom.xml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
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>
@@ -41,7 +41,9 @@
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>
@@ -65,9 +67,9 @@
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>

0 commit comments

Comments
 (0)