#153 [root] Add dokka plugin to generate javadocs for kotlin files

reinert · Apr 2, 2023 · ff44b39 · ff44b39
1 parent d3d6aaa
commit ff44b39
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 35 deletions.
diff --git a/pom.xml b/pom.xml
@@ -73,6 +73,10 @@
     <javapoet.version>1.13.0</javapoet.version>
     <checkstyle.version>7.8.2</checkstyle.version>
 
+    <!-- Kotlin -->
+    <kotlin.version>1.8.10</kotlin.version>
+    <kotlinx-coroutines.version>1.6.4</kotlinx-coroutines.version>
+
     <!-- Testing -->
     <junit.version>4.13.2</junit.version>
     <compile-testing.version>0.19</compile-testing.version>
@@ -243,6 +247,45 @@
           </configuration>
         </plugin>
 
+        <plugin>
+          <groupId>org.jetbrains.kotlin</groupId>
+          <artifactId>kotlin-maven-plugin</artifactId>
+          <version>${kotlin.version}</version>
+          <executions>
+            <execution>
+              <id>compile</id>
+              <phase>compile</phase>
+              <goals>
+                <goal>compile</goal>
+              </goals>
+            </execution>
+            <execution>
+              <id>test-compile</id>
+              <phase>test-compile</phase>
+              <goals>
+                <goal>test-compile</goal>
+              </goals>
+            </execution>
+          </executions>
+        </plugin>
+
+        <plugin>
+          <groupId>org.jetbrains.dokka</groupId>
+          <artifactId>dokka-maven-plugin</artifactId>
+          <version>${kotlin.version}</version>
+          <configuration>
+            <outputDir>${project.basedir}/target/javadoc</outputDir>
+          </configuration>
+          <executions>
+            <execution>
+              <phase>pre-site</phase>
+              <goals>
+                <goal>javadoc</goal>
+              </goals>
+            </execution>
+          </executions>
+        </plugin>
+
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-release-plugin</artifactId>

diff --git a/requestor/ext/requestor-kotlin/pom.xml b/requestor/ext/requestor-kotlin/pom.xml
@@ -27,11 +27,6 @@
 
     <artifactId>requestor-kotlin</artifactId>
 
-    <properties>
-        <kotlin.version>1.8.10</kotlin.version>
-        <kotlinx-coroutines.version>1.6.4</kotlinx-coroutines.version>
-    </properties>
-
     <dependencies>
         <!-- Kotlin dependencies -->
         <dependency>
@@ -84,38 +79,10 @@
             <plugin>
                 <groupId>org.jetbrains.kotlin</groupId>
                 <artifactId>kotlin-maven-plugin</artifactId>
-                <version>${kotlin.version}</version>
-                <executions>
-                    <execution>
-                        <id>compile</id>
-                        <phase>compile</phase>
-                        <goals>
-                            <goal>compile</goal>
-                        </goals>
-                    </execution>
-                    <execution>
-                        <id>test-compile</id>
-                        <phase>test-compile</phase>
-                        <goals>
-                            <goal>test-compile</goal>
-                        </goals>
-                    </execution>
-                </executions>
             </plugin>
-
             <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-compiler-plugin</artifactId>
-                <configuration>
-                    <source>${java.version}</source>
-                    <target>${java.version}</target>
-                    <compilerArgs>
-                        <arg>-Xlint:all</arg>
-                        <arg>-Xlint:-processing</arg>
-                    </compilerArgs>
-                    <showWarnings>true</showWarnings>
-                    <showDeprecation>true</showDeprecation>
-                </configuration>
+                <groupId>org.jetbrains.dokka</groupId>
+                <artifactId>dokka-maven-plugin</artifactId>
             </plugin>
         </plugins>
     </build>

diff --git a/.../ext/requestor-kotlin/src/main/kotlin/io/reinert/requestor/kotlin/CoroutineAsyncRunner.kt b/.../ext/requestor-kotlin/src/main/kotlin/io/reinert/requestor/kotlin/CoroutineAsyncRunner.kt
@@ -29,9 +29,19 @@ import kotlinx.coroutines.channels.Channel
 
 import io.reinert.requestor.core.AsyncRunner
 
+/**
+ * AsyncRunner bound to a coroutine scope.
+ *
+ * @author Danilo Reinert
+ */
 class CoroutineAsyncRunner(private val scope: CoroutineScope,
                            private val dispatcher: CoroutineDispatcher? = null) : AsyncRunner {
 
+    /**
+     * Lock implementation based on kotlin channels.
+     *
+     * @author Danilo Reinert
+     */
     class Lock(private val scope: CoroutineScope) : AsyncRunner.Lock {
 
         private var channel: Channel<Unit>? = null