Added docs.

build.gradle.kts

@@ -1,4 +1,5 @@
 import com.jfrog.bintray.gradle.tasks.BintrayUploadTask
+import org.jetbrains.dokka.gradle.DokkaTask
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 import java.io.FileInputStream
 import java.net.URL
@@ -115,6 +116,30 @@ val javadocJar by tasks.creating(Jar::class) {
     group = JavaBasePlugin.DOCUMENTATION_GROUP
 }
 
+val dokkaDocs by tasks.creating(DokkaTask::class) {
+    outputFormat = "gfm"
+    outputDirectory = "$projectDir"
+
+    configuration {
+        moduleName = "docs"
+        sourceLink {
+            path = file("$projectDir/src/main/kotlin").toURI().toString().replace("file:", "")
+            url = "https://github.com/ethauvin/${project.name}/tree/master/src/main/kotlin"
+            lineSuffix = "#L"
+        }
+
+        jdkVersion = 8
+
+        externalDocumentationLink {
+            url = URL("https://javaee.github.io/javaee-spec/javadocs/")
+            packageListUrl = URL("https://javaee.github.io/javaee-spec/javadocs/package-list")
+        }
+
+        includes = listOf("config/dokka/packages.md")
+        includeNonPublic = false
+    }
+}
+
 tasks {
     withType<Test> {
         useTestNG()

config/dokka/packages.md

@@ -2,4 +2,8 @@
 
 [Akismet for Kotlin/Java](https://github.com/ethauvin/akismet-kotlin), a client library for accessing the [Automattic Kismet](https://www.akismet.com/) (Akismet) spam comments filtering service.
 
+# package net.thauvin.erik.akismet
+
+A Kotlin/Java library for accessing the Akismet service.
+
 

docs/alltypes/index.md

@@ -0,0 +1,22 @@
+
+
+[Akismet for Kotlin/Java](https://github.com/ethauvin/akismet-kotlin), a client library for accessing the [Automattic Kismet](https://www.akismet.com/) (Akismet) spam comments filtering service.
+
+### All Types
+
+| Name | Summary |
+|---|---|
+|
+
+##### [net.thauvin.erik.akismet.Akismet](../net.thauvin.erik.akismet/-akismet/index.md)
+
+Provides access to the [Akismet API](https://akismet.com/development/api/).
+
+
+|
+
+##### [net.thauvin.erik.akismet.AkismetComment](../net.thauvin.erik.akismet/-akismet-comment/index.md)
+
+A comment to send to Akismet.
+
+

docs/index.md

@@ -0,0 +1,13 @@
+[docs](./index.md)
+
+[Akismet for Kotlin/Java](https://github.com/ethauvin/akismet-kotlin), a client library for accessing the [Automattic Kismet](https://www.akismet.com/) (Akismet) spam comments filtering service.
+
+### Packages
+
+| Name | Summary |
+|---|---|
+| [net.thauvin.erik.akismet](net.thauvin.erik.akismet/index.md) | A Kotlin/Java library for accessing the Akismet service. |
+
+### Index
+
+[All Types](alltypes/index.md)

docs/net.thauvin.erik.akismet/-akismet-comment/-a-d-m-i-n_-r-o-l-e.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [ADMIN_ROLE](./-a-d-m-i-n_-r-o-l-e.md)
+
+# ADMIN_ROLE
+
+`const val ADMIN_ROLE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L93)
+
+Administrator role. If used, Akismet will always return false.
+

docs/net.thauvin.erik.akismet/-akismet-comment/-init-.md

@@ -0,0 +1,37 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [<init>](./-init-.md)
+
+# <init>
+
+`AkismetComment(request: `[`HttpServletRequest`](https://javaee.github.io/javaee-spec/javadocs/javax/servlet/http/HttpServletRequest.html)`)`
+
+Create an Akismet comment extracting the [userIp](user-ip.md), [userAgent](user-agent.md), [referrer](referrer.md) and [serverEnv](server-env.md) environment variables
+from a Servlet request.
+
+See the
+[Akismet API](https://akismet.com/development/api/#comment-check) for more details.
+
+**See Also**
+
+[serverEnv](server-env.md)
+
+`AkismetComment(userIp: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
+
+Create an Akismet comment instance.
+
+See the [Akismet API](https://akismet.com/development/api/#comment-check) for more details.
+
+### Parameters
+
+`userIp` - IP address of the comment submitter.
+
+`userAgent` - User agent string of the web browser submitting the comment.
+
+**Constructor**
+
+Create an Akismet comment instance.
+
+
+
+
+See the [Akismet API](https://akismet.com/development/api/#comment-check) for more details.
+

docs/net.thauvin.erik.akismet/-akismet-comment/-t-y-p-e_-b-l-o-g_-p-o-s-t.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [TYPE_BLOG_POST](./-t-y-p-e_-b-l-o-g_-p-o-s-t.md)
+
+# TYPE_BLOG_POST
+
+`const val TYPE_BLOG_POST: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L72)
+
+A blog post.
+

docs/net.thauvin.erik.akismet/-akismet-comment/-t-y-p-e_-c-o-m-m-e-n-t.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [TYPE_COMMENT](./-t-y-p-e_-c-o-m-m-e-n-t.md)
+
+# TYPE_COMMENT
+
+`const val TYPE_COMMENT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L63)
+
+A blog comment.
+

docs/net.thauvin.erik.akismet/-akismet-comment/-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [TYPE_CONTACT_FORM](./-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.md)
+
+# TYPE_CONTACT_FORM
+
+`const val TYPE_CONTACT_FORM: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L75)
+
+A contact form or feedback form submission.
+

docs/net.thauvin.erik.akismet/-akismet-comment/-t-y-p-e_-f-o-r-u-m_-p-o-s-t.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [TYPE_FORUM_POST](./-t-y-p-e_-f-o-r-u-m_-p-o-s-t.md)
+
+# TYPE_FORUM_POST
+
+`const val TYPE_FORUM_POST: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L66)
+
+A top-level forum post.
+

docs/net.thauvin.erik.akismet/-akismet-comment/-t-y-p-e_-m-e-s-s-a-g-e.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [TYPE_MESSAGE](./-t-y-p-e_-m-e-s-s-a-g-e.md)
+
+# TYPE_MESSAGE
+
+`const val TYPE_MESSAGE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L81)
+
+A message sent between just a few users.
+

docs/net.thauvin.erik.akismet/-akismet-comment/-t-y-p-e_-p-i-n-g-b-a-c-k.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [TYPE_PINGBACK](./-t-y-p-e_-p-i-n-g-b-a-c-k.md)
+
+# TYPE_PINGBACK
+
+`const val TYPE_PINGBACK: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L84)
+
+A pingback.
+

docs/net.thauvin.erik.akismet/-akismet-comment/-t-y-p-e_-r-e-p-l-y.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [TYPE_REPLY](./-t-y-p-e_-r-e-p-l-y.md)
+
+# TYPE_REPLY
+
+`const val TYPE_REPLY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L69)
+
+A reply to a top-level forum post.
+

docs/net.thauvin.erik.akismet/-akismet-comment/-t-y-p-e_-s-i-g-n-u-p.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [TYPE_SIGNUP](./-t-y-p-e_-s-i-g-n-u-p.md)
+
+# TYPE_SIGNUP
+
+`const val TYPE_SIGNUP: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L78)
+
+A new user account.
+

docs/net.thauvin.erik.akismet/-akismet-comment/-t-y-p-e_-t-r-a-c-k-b-a-c-k.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [TYPE_TRACKBACK](./-t-y-p-e_-t-r-a-c-k-b-a-c-k.md)
+
+# TYPE_TRACKBACK
+
+`const val TYPE_TRACKBACK: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L87)
+
+A trackback.
+

docs/net.thauvin.erik.akismet/-akismet-comment/-t-y-p-e_-t-w-e-e-t.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [TYPE_TWEET](./-t-y-p-e_-t-w-e-e-t.md)
+
+# TYPE_TWEET
+
+`const val TYPE_TWEET: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L90)
+
+A Twitter message.
+

docs/net.thauvin.erik.akismet/-akismet-comment/author-email.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [authorEmail](./author-email.md)
+
+# authorEmail
+
+`var authorEmail: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L138)
+
+Email address submitted with the comment.
+

docs/net.thauvin.erik.akismet/-akismet-comment/author-url.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [authorUrl](./author-url.md)
+
+# authorUrl
+
+`var authorUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L144)
+
+URL submitted with comment.
+

docs/net.thauvin.erik.akismet/-akismet-comment/author.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [author](./author.md)
+
+# author
+
+`var author: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L132)
+
+Name submitted with the comment.
+

docs/net.thauvin.erik.akismet/-akismet-comment/blog-charset.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [blogCharset](./blog-charset.md)
+
+# blogCharset
+
+`var blogCharset: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L190)
+
+The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1
+

docs/net.thauvin.erik.akismet/-akismet-comment/blog-lang.md

@@ -0,0 +1,10 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [blogLang](./blog-lang.md)
+
+# blogLang
+
+`var blogLang: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L182)
+
+Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.
+
+A site with articles in English and French might use: `en, fr_ca`
+

docs/net.thauvin.erik.akismet/-akismet-comment/content.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [content](./content.md)
+
+# content
+
+`var content: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L150)
+
+The content that was submitted.
+

docs/net.thauvin.erik.akismet/-akismet-comment/date-gmt.md

@@ -0,0 +1,14 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [dateGmt](./date-gmt.md)
+
+# dateGmt
+
+`var dateGmt: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L162)
+
+The UTC timestamp of the creation of the comment, in ISO 8601 format.
+
+May be omitted if the comment is sent to the API at the time it is created.
+
+**See Also**
+
+[Akismet.dateToGmt](../-akismet/date-to-gmt.md)
+

docs/net.thauvin.erik.akismet/-akismet-comment/equals.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [equals](./equals.md)
+
+# equals
+
+`open fun equals(other: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L269)
+
+Indicates whether some other object is *equal to* this one.
+

docs/net.thauvin.erik.akismet/-akismet-comment/hash-code.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [hashCode](./hash-code.md)
+
+# hashCode
+
+`open fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L300)
+
+Returns a hash code value for the object.
+