Added docs.

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.
+

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

@@ -0,0 +1,66 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](./index.md)
+
+# AkismetComment
+
+`open class AkismetComment` [(source)](https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt#L59)
+
+A comment to send to Akismet.
+
+Most everything is optional. Performance can drop dramatically if you choose to exclude data points. The more data
+you send Akismet about each comment, the greater the accuracy. They recommend erring on the side of including
+too much data.
+
+See the [Akismet API](https://akismet.com/development/api/#comment-check) for more details.
+
+### Constructors
+
+| Name | Summary |
+|---|---|
+| [&lt;init&gt;](-init-.md) | 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.`AkismetComment(request: `[`HttpServletRequest`](https://javaee.github.io/javaee-spec/javadocs/javax/servlet/http/HttpServletRequest.html)`)`<br>Create an Akismet comment instance.`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)`)` |
+
+### Properties
+
+| Name | Summary |
+|---|---|
+| [author](author.md) | Name submitted with the comment.`var author: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
+| [authorEmail](author-email.md) | Email address submitted with the comment.`var authorEmail: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
+| [authorUrl](author-url.md) | URL submitted with comment.`var authorUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
+| [blogCharset](blog-charset.md) | The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1`var blogCharset: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
+| [blogLang](blog-lang.md) | Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.`var blogLang: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
+| [content](content.md) | The content that was submitted.`var content: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
+| [dateGmt](date-gmt.md) | The UTC timestamp of the creation of the comment, in ISO 8601 format.`var dateGmt: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
+| [isTest](is-test.md) | This is an optional parameter. You can use it when submitting test queries to Akismet.`var isTest: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) |
+| [permalink](permalink.md) | The full permanent URL of the entry the comment was submitted to.`var permalink: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
+| [postModifiedGmt](post-modified-gmt.md) | The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.`var postModifiedGmt: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
+| [recheckReason](recheck-reason.md) | If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.`var recheckReason: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
+| [referrer](referrer.md) | The content of the referer header should be set here.`var referrer: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
+| [serverEnv](server-env.md) | In PHP, there is an array of environmental variables called `$_SERVER` that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.`var serverEnv: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` |
+| [type](type.md) | A string that describes the type of content being sent, such as:`var type: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
+| [userAgent](user-agent.md) | User agent string of the web browser submitting the comment.`val userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [userIp](user-ip.md) | IP address of the comment submitter.`val userIp: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [userRole](user-role.md) | The user role of the user who submitted the comment. This is an optional parameter.`var userRole: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
+
+### Functions
+
+| Name | Summary |
+|---|---|
+| [equals](equals.md) | Indicates whether some other object is *equal to* this one.`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) |
+| [hashCode](hash-code.md) | Returns a hash code value for the object.`open fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) |
+| [toJson](to-json.md) | Returns a JSON representation of the comment.`fun toJson(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [toString](to-string.md) | Returns a JSON representation of the comment.`open fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+
+### Companion Object Properties
+
+| Name | Summary |
+|---|---|
+| [ADMIN_ROLE](-a-d-m-i-n_-r-o-l-e.md) | Administrator role. If used, Akismet will always return false.`const val ADMIN_ROLE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [TYPE_BLOG_POST](-t-y-p-e_-b-l-o-g_-p-o-s-t.md) | A blog post.`const val TYPE_BLOG_POST: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [TYPE_COMMENT](-t-y-p-e_-c-o-m-m-e-n-t.md) | A blog comment.`const val TYPE_COMMENT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [TYPE_CONTACT_FORM](-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.md) | A contact form or feedback form submission.`const val TYPE_CONTACT_FORM: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [TYPE_FORUM_POST](-t-y-p-e_-f-o-r-u-m_-p-o-s-t.md) | A top-level forum post.`const val TYPE_FORUM_POST: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [TYPE_MESSAGE](-t-y-p-e_-m-e-s-s-a-g-e.md) | A message sent between just a few users.`const val TYPE_MESSAGE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [TYPE_PINGBACK](-t-y-p-e_-p-i-n-g-b-a-c-k.md) | A pingback.`const val TYPE_PINGBACK: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [TYPE_REPLY](-t-y-p-e_-r-e-p-l-y.md) | A reply to a top-level forum post.`const val TYPE_REPLY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [TYPE_SIGNUP](-t-y-p-e_-s-i-g-n-u-p.md) | A new user account.`const val TYPE_SIGNUP: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [TYPE_TRACKBACK](-t-y-p-e_-t-r-a-c-k-b-a-c-k.md) | A trackback.`const val TYPE_TRACKBACK: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [TYPE_TWEET](-t-y-p-e_-t-w-e-e-t.md) | A Twitter message.`const val TYPE_TWEET: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |

docs/net.thauvin.erik.akismet/-akismet-comment/is-test.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [isTest](./is-test.md)
+
+# isTest
+
+`var isTest: `[`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#L206)
+
+This is an optional parameter. You can use it when submitting test queries to Akismet.
+

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

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [permalink](./permalink.md)
+
+# permalink
+
+`var permalink: `[`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#L103)
+
+The full permanent URL of the entry the comment was submitted to.
+

docs/net.thauvin.erik.akismet/-akismet-comment/post-modified-gmt.md

@@ -0,0 +1,12 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [postModifiedGmt](./post-modified-gmt.md)
+
+# postModifiedGmt
+
+`var postModifiedGmt: `[`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#L172)
+
+The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.
+
+**See Also**
+
+[Akismet.dateToGmt](../-akismet/date-to-gmt.md)
+

docs/net.thauvin.erik.akismet/-akismet-comment/recheck-reason.md

@@ -0,0 +1,12 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [recheckReason](./recheck-reason.md)
+
+# recheckReason
+
+`var recheckReason: `[`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#L215)
+
+If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending
+comments that you'd like to recheck, include this parameter with a string describing why the content is
+being rechecked.
+
+For example: `edit`
+

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

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [referrer](./referrer.md)
+
+# referrer
+
+`var referrer: `[`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#L97)
+
+The content of the referer header should be set here.
+

docs/net.thauvin.erik.akismet/-akismet-comment/server-env.md

@@ -0,0 +1,13 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [serverEnv](./server-env.md)
+
+# serverEnv
+
+`var serverEnv: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`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#L228)
+
+In PHP, there is an array of environmental variables called `$_SERVER` that contains information about the Web
+server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to
+Akismet.
+
+How the submitted content interacts with the server can be very telling, so please include as much of it as
+possible.
+

docs/net.thauvin.erik.akismet/-akismet-comment/to-json.md

@@ -0,0 +1,12 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [toJson](./to-json.md)
+
+# toJson
+
+`fun toJson(): `[`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#L252)
+
+Returns a JSON representation of the comment.
+
+**See Also**
+
+[Akismet.jsonComment](../-akismet/json-comment.md)
+

docs/net.thauvin.erik.akismet/-akismet-comment/to-string.md

@@ -0,0 +1,12 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [toString](./to-string.md)
+
+# toString
+
+`open fun toString(): `[`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#L261)
+
+Returns a JSON representation of the comment.
+
+**See Also**
+
+[Akismet.jsonComment](../-akismet/json-comment.md)
+

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

@@ -0,0 +1,23 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [type](./type.md)
+
+# type
+
+`var type: `[`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#L126)
+
+A string that describes the type of content being sent, such as:
+
+* [TYPE_COMMENT](-t-y-p-e_-c-o-m-m-e-n-t.md)
+* [TYPE_FORUM_POST](-t-y-p-e_-f-o-r-u-m_-p-o-s-t.md)
+* [TYPE_REPLY](-t-y-p-e_-r-e-p-l-y.md)
+* [TYPE_BLOG_POST](-t-y-p-e_-b-l-o-g_-p-o-s-t.md)
+* [TYPE_CONTACT_FORM](-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.md)
+* [TYPE_SIGNUP](-t-y-p-e_-s-i-g-n-u-p.md)
+* [TYPE_MESSAGE](-t-y-p-e_-m-e-s-s-a-g-e.md)
+* [TYPE_PINGBACK](-t-y-p-e_-p-i-n-g-b-a-c-k.md)
+* [TYPE_TRACKBACK](-t-y-p-e_-t-r-a-c-k-b-a-c-k.md)
+* [TYPE_TWEET](-t-y-p-e_-t-w-e-e-t.md)
+
+You may send a value not listed above if none of them accurately describe your content.
+
+This is further explained [here](http://blog.akismet.com/2012/06/19/pro-tip-tell-us-your-comment_type/).
+

docs/net.thauvin.erik.akismet/-akismet-comment/user-agent.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [userAgent](./user-agent.md)
+
+# userAgent
+
+`val userAgent: `[`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#L59)
+
+User agent string of the web browser submitting the comment.
+

docs/net.thauvin.erik.akismet/-akismet-comment/user-ip.md

@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [userIp](./user-ip.md)
+
+# userIp
+
+`val userIp: `[`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#L59)
+
+IP address of the comment submitter.
+

docs/net.thauvin.erik.akismet/-akismet-comment/user-role.md

@@ -0,0 +1,10 @@
+[docs](../../index.md) / [net.thauvin.erik.akismet](../index.md) / [AkismetComment](index.md) / [userRole](./user-role.md)
+
+# userRole
+
+`var userRole: `[`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#L200)
+
+The user role of the user who submitted the comment. This is an optional parameter.
+
+If you set it to [ADMIN_ROLE](-a-d-m-i-n_-r-o-l-e.md), Akismet will always return false.
+