More documentation and tidying

build.gradle.kts

         setLicenses("MIT")
         vcsUrl = "https://g.c5h.io/public/ktirc"
     }
-}
+}

src/main/kotlin/com/dmdirc/ktirc/events/CapabilitiesHandler.kt

         }
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/events/ChannelStateHandler.kt

         client.channelState.forEach { it.users -= event.user.nickname }
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/events/EventHandler.kt

         PingHandler(),
         ServerStateHandler(),
         UserStateHandler()
-)
+)

src/main/kotlin/com/dmdirc/ktirc/events/EventUtils.kt

     val modePrefixes = client.serverState.features[ServerFeature.ModePrefixes]!!
     for (user in names) {
         user.takeWhile { modePrefixes.isPrefix(it) }.let { prefix ->
-            yield(Pair(modePrefixes.getModes(prefix), user.substring(prefix.length).asUser()))
+            yield(modePrefixes.getModes(prefix) to user.substring(prefix.length).asUser())
         }
     }
 }.toList()

src/main/kotlin/com/dmdirc/ktirc/events/Events.kt

 import com.dmdirc.ktirc.model.User
 import java.time.LocalDateTime
 
+/** Base class for all events. */
 sealed class IrcEvent(val time: LocalDateTime)
 
 /** Raised when the server initially welcomes us to the IRC network. */
 class ServerCapabilitiesAcknowledged(time: LocalDateTime, val capabilities: Map<Capability, String>) : IrcEvent(time)
 
 /** Raised when the server has finished sending us capabilities. */
-class ServerCapabilitiesFinished(time: LocalDateTime) : IrcEvent(time)
+class ServerCapabilitiesFinished(time: LocalDateTime) : IrcEvent(time)

src/main/kotlin/com/dmdirc/ktirc/events/PingHandler.kt

         }
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/events/ServerStateHandler.kt

         }
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/events/UserStateHandler.kt

         state -= event.user
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/io/CaseMapping.kt

     private fun areEquivalent(char1: Char, char2: Char) = char1 == char2 || char1.toUpper() == char2.toUpper()
     private fun Char.toUpper() = this + if (this.toInt() in lowerToUpperMapping.first) lowerToUpperMapping.second.start - lowerToUpperMapping.first.start else 0
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/io/LineBufferedSocket.kt

         const val LINE_FEED = '\n'.toByte()
     }
 
-    public var tlsTrustManager: X509TrustManager? = null
+    var tlsTrustManager: X509TrustManager? = null
 
     private val log by logger()
 
             index = count + index - start
         }
     }
-}
+}

src/main/kotlin/com/dmdirc/ktirc/io/MessageHandler.kt

         null
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/io/MessageParser.kt

             val index = tag.indexOf('=')
             val name = if (index == -1) tag else tag.substring(0 until index)
             messageTags[name]?.let {
-                yield(Pair(it, if (index == -1) "" else tag.substring(index + 1).unescapeTagValue()))
+                yield(it to if (index == -1) "" else tag.substring(index + 1).unescapeTagValue())
             } ?: log.severe { "Unknown message tag: $name"}
         }
     }.toMap()
         return cursor
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/CapabilityProcessor.kt

             val index = cap.indexOf('=')
             val name = if (index == -1) cap else cap.substring(0 until index)
             val value = if (index == -1) "" else cap.substring(index + 1)
-            capabilities[name]?.let { yield(Pair(it, value)) } ?: log.info { "Unknown capability: $name (value: $value)" }
+            capabilities[name]?.let { yield(it to value) } ?: log.info { "Unknown capability: $name (value: $value)" }
         }
     }.toMap()
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/ISupportProcessor.kt

         }
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/JoinProcessor.kt

         }
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/MessageBuilders.kt

 package com.dmdirc.ktirc.messages
 
-fun capabilityEndMessage() = "CAP END"
-fun capabilityRequestMessage(capabilities: List<String>) = "CAP REQ :${capabilities.joinToString(" ")}"
+/** Construct a message indicating the end of capability negotiation. */
+internal fun capabilityEndMessage() = "CAP END"
+/** Construct a message requesting the specified caps are enabled. */
+internal fun capabilityRequestMessage(capabilities: List<String>) = "CAP REQ :${capabilities.joinToString(" ")}"
+/** Construct a message to join the given channel. */
 fun joinMessage(channel: String) = "JOIN :$channel"
+/** Construct a message to change to the given nickname. */
 fun nickMessage(nick: String) = "NICK :$nick"
-fun passwordMessage(password: String) = "PASS :$password"
-fun pongMessage(nonce: ByteArray) = "PONG :${String(nonce)}"
+/** Construct a message to provide the connection password to the server. */
+internal fun passwordMessage(password: String) = "PASS :$password"
+/** Construct a message to reply to a PING event. */
+internal fun pongMessage(nonce: ByteArray) = "PONG :${String(nonce)}"
+/** Construct a message to send a private message to a user or channel. */
 fun privmsgMessage(target: String, message: String) = "PRIVMSG $target :$message"
-fun userMessage(userName: String, localHostName: String, serverHostName: String, realName: String) = "USER $userName $localHostName $serverHostName :$realName"
+/** Construct a message to register a user with the server. */
+internal fun userMessage(userName: String, localHostName: String, serverHostName: String, realName: String) = "USER $userName $localHostName $serverHostName :$realName"

src/main/kotlin/com/dmdirc/ktirc/messages/MessageProcessor.kt

         PrivmsgProcessor(),
         QuitProcessor(),
         WelcomeProcessor()
-)
+)

src/main/kotlin/com/dmdirc/ktirc/messages/PartProcessor.kt

     private val IrcMessage.reason
         get() = if (params.size > 1) String(params[1]) else ""
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/PingProcessor.kt

 
     override fun process(message: IrcMessage) = listOf(PingReceived(message.time, message.params[0]))
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/PrivmsgProcessor.kt

         listOf(MessageReceived(message.time, user, String(message.params[0]), String(message.params[1])))
     } ?: emptyList()
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/QuitProcessor.kt

     private val IrcMessage.reason
         get() = if (params.isNotEmpty()) String(params[0]) else ""
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/WelcomeProcessor.kt

 
     override fun process(message: IrcMessage) = listOf(ServerWelcome(message.time, String(message.params[0])))
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/model/CaseInsensitiveSet.kt

 
     fun isEmpty() = items.isEmpty()
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/model/IrcMessage.kt

 
 internal val messageTags: Map<String, MessageTag> by lazy {
     MessageTag::class.nestedClasses.map { it.objectInstance as MessageTag }.associateBy { it.name }
-}
+}

src/main/kotlin/com/dmdirc/ktirc/model/Server.kt

 package com.dmdirc.ktirc.model
 
-data class Server(val host: String, val port: Int, val tls: Boolean = false, val password: String? = null)
+data class Server(val host: String, val port: Int, val tls: Boolean = false, val password: String? = null)

src/main/kotlin/com/dmdirc/ktirc/model/ServerState.kt

 
 internal val serverFeatures: Map<String, ServerFeature<*>> by lazy {
     ServerFeature::class.nestedClasses.map { it.objectInstance as ServerFeature<*> }.associateBy { it.name }
-}
+}

src/main/kotlin/com/dmdirc/ktirc/model/User.kt

     } else {
         User(this)
     }
-}
+}

src/main/kotlin/com/dmdirc/ktirc/model/UserState.kt

     operator fun minusAssign(channel: String) { channels -= channel }
     operator fun contains(channel: String) = channel in channels
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/util/Logging.kt

 
 internal fun <R : Any> R.logger(): Lazy<Logger> {
     return lazy { logger(this::class) }
-}
+}