docs: add doc comments to packages (#203)

api.go

@@ -1,3 +1,4 @@
+// Package don provides a fast and efficient API framework.
 package don
 
 import (
@@ -101,7 +102,7 @@ func (r *API) Handler(method, path string, handle http.Handler) {
 	r.router.Handler(method, path, handle)
 }
 
-// HandlerFunc is an adapter which allows the usage of an http.HandlerFunc as a request handle.
+// HandleFunc is an adapter which allows the usage of an http.HandlerFunc as a request handle.
 func (r *API) HandleFunc(method, path string, handle http.HandlerFunc) {
 	r.router.HandlerFunc(method, path, handle)
 }

encoding/form/form.go

@@ -1,3 +1,4 @@
+// Package form provides decoding of form data.
 package form
 
 import (

encoding/json/json.go

@@ -1,3 +1,4 @@
+// Package json provides encoding and decoding of JSON data.
 package json
 
 import (

encoding/msgpack/msgpack.go

@@ -1,3 +1,4 @@
+// Package msgpack provides encoding and decoding of MessagePack data.
 package msgpack
 
 import (

encoding/protobuf/protobuf.go

@@ -1,3 +1,4 @@
+// Package protobuf provides encoding and decoding of Protocol Buffers data.
 package protobuf
 
 import (

encoding/text/text.go

@@ -1,3 +1,4 @@
+// Package text provides encoding and decoding of plain text data.
 package text
 
 import (

encoding/toml/toml.go

@@ -1,3 +1,4 @@
+// Package toml provides encoding and decoding of TOML data.
 package toml
 
 import (

encoding/xml/xml.go

@@ -1,3 +1,4 @@
+// Package xml provides encoding and decoding of XML data.
 package xml
 
 import (

encoding/yaml/yaml.go

@@ -1,3 +1,4 @@
+// Package yaml provides encoding and decoding of YAML data.
 package yaml
 
 import (

internal/byteconv/byteconv.go

@@ -1,14 +1,17 @@
+// Package byteconv provides fast and efficient conversion functions for byte slices and strings.
 package byteconv
 
 import (
 	"reflect"
 	"unsafe"
 )
 
+// Btoa returns a string from a byte slice without memory allocation.
 func Btoa(b []byte) string {
 	return *(*string)(unsafe.Pointer(&b))
 }
 
+// Atob returns a byte slice from a string without memory allocation.
 func Atob(s string) []byte {
 	sp := unsafe.Pointer(&s)
 	b := *(*[]byte)(sp)

pkg/httptest/request.go

@@ -1,3 +1,4 @@
+// Package httptest provides utilities for testing fasthttp handlers.
 package httptest
 
 import (
@@ -6,6 +7,7 @@ import (
 	"github.com/valyala/fasthttp"
 )
 
+// NewRequest returns a new [fasthttp.RequestCtx] with the given method, url, body and header.
 func NewRequest(method, url, body string, header map[string]string) *fasthttp.RequestCtx {
 	ctx := &fasthttp.RequestCtx{}
 	ctx.Request.Header.SetMethod(method)