docs: add more doc comments

Author: mdigger

client.go

@@ -12,6 +12,7 @@ import (
 
 // spell-checker:words myevents bgapi noevents nixevent sendevent
 
+// Client represents a client FreeSWITCH connection.
 type Client struct {
 	conn   *conn
 	chErr  chan error

cmd.go

@@ -9,6 +9,7 @@ import (
 	"strings"
 )
 
+// command defines a structure of a ESL command.
 type command struct {
 	name    string
 	params  string

event.go

@@ -15,6 +15,7 @@ import (
 	"time"
 )
 
+// Event represents an ESL event with headers and a body.
 type Event struct {
 	headers map[string]string
 	body    []byte

events.go

@@ -5,6 +5,7 @@ import (
 	"strings"
 )
 
+// eventNames is a map that contains the predefined names of various events as keys.
 var eventNames = map[string]struct{}{
 	// spell-checker:disable
 	"CUSTOM":                   {},

options.go

@@ -6,9 +6,13 @@ import (
 	"log/slog"
 )
 
+// Option is a function type used to modify configuration options.
 type Option func(*config)
 
 // WithEvents returns an Option that sets the events channel of a config.
+//
+// If the autoClose parameter is specified, the channel will be automatically
+// closed when the connection to the server is closed.
 func WithEvents(events chan<- Event, autoClose ...bool) Option {
 	return func(c *config) {
 		c.events = events
@@ -23,12 +27,16 @@ func WithLog(log *slog.Logger) Option {
 	}
 }
 
+// WithDumpIn sets the writer to record all incoming messages.
+// It is used for logging during debugging.
 func WithDumpIn(w io.Writer) Option {
 	return func(c *config) {
 		c.r = w
 	}
 }
 
+// WithDumpOut sets the writer to record all outgoing commands.
+// It is used for logging during debugging.
 func WithDumpOut(w io.Writer) Option {
 	return func(c *config) {
 		c.w = w