Improve Javadoc/Dokka generation

build.gradle

@@ -9,6 +9,7 @@ buildscript {
     dependencies {
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$versions.kotlin"
         classpath "com.github.ben-manes:gradle-versions-plugin:$versions.plugins.gradleVersions"
+        classpath "org.jetbrains.dokka:dokka-gradle-plugin:$versions.plugins.dokka"
     }
 }
 

gradle/versions.gradle

@@ -5,6 +5,7 @@ def versions = [:]
 def plugins = [:]
 plugins.with {
     gradleVersions = '0.21.0'
+    dokka = '0.9.18'
 }
 versions.plugins = plugins
 

library/build.gradle

@@ -4,6 +4,7 @@ apply plugin: 'java-library'
 apply plugin: 'kotlin'
 apply plugin: 'maven-publish'
 apply plugin: "idea"
+apply plugin: 'org.jetbrains.dokka'
 
 compileKotlin {
     kotlinOptions {
@@ -20,7 +21,13 @@ task sourcesJar(type: Jar, dependsOn: classes) {
     from sourceSets.main.allSource
 }
 
-task javadocJar(type: Jar, dependsOn: javadoc) {
+task dokkaJavadoc(type: org.jetbrains.dokka.gradle.DokkaTask) {
+    outputFormat = 'html'
+    outputDirectory = javadoc.destinationDir
+    inputs.dir 'src/main/kotlin'
+}
+
+task javadocJar(type: Jar, dependsOn: dokkaJavadoc) {
     classifier = 'javadoc'
     from javadoc.destinationDir
 }

library/src/main/kotlin/org/jraf/klibqonto/client/QontoClient.kt

@@ -62,7 +62,7 @@ interface QontoClient {
          * and [iban][org.jraf.klibqonto.model.organizations.BankAccount.iban] will be required for you to retrieve the
          * list of transactions inside that bank account, using [Transactions.getTransactionList].
          *
-         * @see <a href="https://api-doc.qonto.eu/2.0/organizations/show-organization-1">API documentation</a>
+         * See also [the API documentation](https://api-doc.qonto.eu/2.0/organizations/show-organization-1)
          */
         suspend fun getOrganization(): Organization
     }
@@ -95,7 +95,7 @@ interface QontoClient {
          * @param sortOrder sort order (default: descending)
          * @param pagination pagination settings
          *
-         * @see <a href="https://api-doc.qonto.eu/2.0/transactions/list-transactions">API documentation</a>
+         * See also [the API documentation](https://api-doc.qonto.eu/2.0/transactions/list-transactions)
          */
         suspend fun getTransactionList(
             slug: String,
@@ -122,7 +122,7 @@ interface QontoClient {
          * The [id][org.jraf.klibqonto.model.memberships.Membership.id] field uniquely identifies the membership
          * and is used to identify the [initiator of a transaction][org.jraf.klibqonto.model.transactions.Transaction.initiatorId].
          *
-         * @see <a href="https://api-doc.qonto.eu/2.0/memberships/list-memberships">API documentation</a>
+         * See also [the API documentation](https://api-doc.qonto.eu/2.0/memberships/list-memberships)
          */
         suspend fun getMembershipList(
             pagination: Pagination = Pagination()
@@ -145,7 +145,7 @@ interface QontoClient {
          * The parent label can be identified thanks to the [parentId][org.jraf.klibqonto.model.labels.Label.parentId]
          * field.
          *
-         * @see <a href="https://api-doc.qonto.eu/2.0/labels/list-labels">API documentation</a>
+         * See also [the API documentation](https://api-doc.qonto.eu/2.0/labels/list-labels)
          */
         suspend fun getLabelList(
             pagination: Pagination = Pagination()
@@ -172,7 +172,7 @@ interface QontoClient {
          *
          * @param id the id of the [Attachment] to retrieve
          *
-         * @see <a href="https://api-doc.qonto.eu/2.0/attachments/show-attachment">API documentation</a>
+         * See also [the API documentation](https://api-doc.qonto.eu/2.0/attachments/show-attachment)
          */
         suspend fun getAttachment(id: String): Attachment
     }