Add remaining doc comments

Author: MaxDesiatov

Sources/GDBRemoteProtocol/GDBHostCommand.swift

@@ -16,6 +16,7 @@
 /// * https://sourceware.org/gdb/current/onlinedocs/gdb.html/General-Query-Packets.html
 /// * https://lldb.llvm.org/resources/lldbgdbremote.html
 package struct GDBHostCommand: Equatable {
+    /// Kind of the command sent from the debugger host to the debugger target.
     package enum Kind: String, Equatable {
         // Currently listed in the order that LLDB sends them in.
         case startNoAckMode

Sources/GDBRemoteProtocol/GDBHostCommandDecoder.swift

@@ -80,8 +80,17 @@ package struct GDBHostCommandDecoder: ByteToMessageDecoder {
     package var accummulatedChecksum: UInt8 {
         UInt8(self.accummulatedSum % 256)
     }
-
+    
+    /// Whether `QStartNoAckMode` command was sent. Note that this is separate
+    /// from ``isNoAckModeActive``. This mode is "activated" for the subsequent
+    /// host command, which is when `isNoAckModeActive` is set by the decoder to
+    /// `false`, but not for the immediate response.
+    /// See https://sourceware.org/gdb/current/onlinedocs/gdb.html/Packet-Acknowledgment.html#Packet-Acknowledgment
     private var isNoAckModeRequested = false
+
+    /// Whether `QStartNoAckMode` command was sent and this mode has been
+    /// subsequently activated.
+    /// See https://sourceware.org/gdb/current/onlinedocs/gdb.html/Packet-Acknowledgment.html#Packet-Acknowledgment
     private var isNoAckModeActive = false
 
     package mutating func decode(

Sources/GDBRemoteProtocol/GDBTargetResponse.swift

@@ -22,21 +22,43 @@ package enum VContActions: String {
     case stepInRange = "r"
 }
 
+/// A response sent from a debugger target (a device
+/// or a virtual machine being debugged) to a debugger host (GDB or LLDB).
+/// See GDB remote protocol documentation for more details:
+/// * https://sourceware.org/gdb/current/onlinedocs/gdb.html/General-Query-Packets.html
 package struct GDBTargetResponse {
+    /// Kind of the response sent from the debugger target to the debugger host.
     package enum Kind {
+        /// Standard `OK` response.
         case ok
+
+        /// A list of key-value pairs, with keys delimited from values by a colon `:`
+        /// character, and pairs in the list delimited by the semicolon `;` character.
         case keyValuePairs(KeyValuePairs<String, String>)
+
+        /// List of ``VContActions`` values delimited by the semicolon `;` character.
         case vContSupportedActions([VContActions])
+
+        /// Raw string included as is in the response.
         case string(String)
+
+        /// Binary buffer hex-encoded in the response.
         case hexEncodedBinary(ByteBufferView)
+
+        /// Standard empty response (no content is sent).
         case empty
     }
 
     package let kind: Kind
-    package let isNoAckModeActivated: Bool
 
-    package init(kind: Kind, isNoAckModeActivated: Bool) {
+    /// Whether `QStartNoAckMode` is activated and no ack `+` symbol should be sent
+    /// before encoding this response.
+    /// See https://sourceware.org/gdb/current/onlinedocs/gdb.html/Packet-Acknowledgment.html#Packet-Acknowledgment
+    package let isNoAckModeActivate: Bool
+    
+    /// Member-wise initializer for the debugger response.
+    package init(kind: Kind, isNoAckModeActivate: Bool) {
         self.kind = kind
-        self.isNoAckModeActivated = isNoAckModeActivated
+        self.isNoAckModeActivate = isNoAckModeActivate
     }
 }

Sources/GDBRemoteProtocol/GDBTargetResponseEncoder.swift

@@ -14,11 +14,16 @@ import Foundation
 import NIOCore
 
 extension String {
+    /// Computes a GDB RP checksum of characters in a given string.
     fileprivate var appendedChecksum: String {
         "\(self)#\(String(format:"%02X", self.utf8.reduce(0, { $0 + Int($1) }) % 256))"
     }
 }
 
+/// Encoder of GDB RP target responses, that takes ``GDBTargetResponse`` as an input
+/// and encodes it per https://sourceware.org/gdb/current/onlinedocs/gdb.html/Overview.html#Overview
+/// format in a `ByteBuffer` value as output. This encoder is compatible with NIO channel pipelines,
+/// making it easy to integrate with different I/O configurations.
 package class GDBTargetResponseEncoder: MessageToByteEncoder {
     private var isNoAckModeActive = false
 
@@ -27,7 +32,7 @@ package class GDBTargetResponseEncoder: MessageToByteEncoder {
         if !isNoAckModeActive {
             out.writeInteger(UInt8(ascii: "+"))
         }
-        if data.isNoAckModeActivated {
+        if data.isNoAckModeActivate {
             self.isNoAckModeActive = true
         }
         out.writeInteger(UInt8(ascii: "$"))