📒 docs: Ensure all exported elements are documented (gofiber#3752)

* docs: clarify short go doc comments

* Update register.go

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Author: 2 people

app.go

@@ -1176,6 +1176,7 @@ func (app *App) Test(req *http.Request, config ...TestConfig) (*http.Response, e
 
 type disableLogger struct{}
 
+// Printf implements the fasthttp Logger interface and discards log output.
 func (*disableLogger) Printf(string, ...any) {
 }
 

bind.go

@@ -30,7 +30,7 @@ var bindPool = sync.Pool{
 	},
 }
 
-// Bind struct
+// Bind provides helper methods for binding request data to Go values.
 type Bind struct {
 	ctx            Ctx
 	dontHandleErrs bool
@@ -331,6 +331,8 @@ func (b *Bind) Body(out any) error {
 	return ErrUnprocessableEntity
 }
 
+// All binds values from URI params, the request body, the query string,
+// headers, and cookies into the provided struct in precedence order.
 func (b *Bind) All(out any) error {
 	outVal := reflect.ValueOf(out)
 	if outVal.Kind() != reflect.Ptr || outVal.Elem().Kind() != reflect.Struct {

binder/binder.go

@@ -71,6 +71,8 @@ var MsgPackBinderPool = sync.Pool{
 	},
 }
 
+// GetFromThePool retrieves a binder from the provided sync.Pool and panics if
+// the stored value cannot be cast to the requested type.
 func GetFromThePool[T any](pool *sync.Pool) T {
 	binder, ok := pool.Get().(T)
 	if !ok {
@@ -80,6 +82,7 @@ func GetFromThePool[T any](pool *sync.Pool) T {
 	return binder
 }
 
+// PutToThePool returns the binder to the provided sync.Pool.
 func PutToThePool[T any](pool *sync.Pool, binder T) {
 	pool.Put(binder)
 }

binder/cbor.go

@@ -24,10 +24,14 @@ func (b *CBORBinding) Reset() {
 	b.CBORDecoder = nil
 }
 
+// UnimplementedCborMarshal panics to signal that a CBOR marshaler must be
+// configured before CBOR support can be used.
 func UnimplementedCborMarshal(_ any) ([]byte, error) {
 	panic("Must explicitly setup CBOR, please check docs: https://docs.gofiber.io/next/guide/advance-format#cbor")
 }
 
+// UnimplementedCborUnmarshal panics to signal that a CBOR unmarshaler must be
+// configured before CBOR support can be used.
 func UnimplementedCborUnmarshal(_ []byte, _ any) error {
 	panic("Must explicitly setup CBOR, please check docs: https://docs.gofiber.io/next/guide/advance-format#cbor")
 }

binder/header.go

@@ -5,7 +5,7 @@ import (
 	"github.com/valyala/fasthttp"
 )
 
-// v is the header binder for header request body.
+// HeaderBinding is the binder implementation used to populate values from HTTP headers.
 type HeaderBinding struct {
 	EnableSplitting bool
 }

binder/mapping.go

@@ -288,7 +288,7 @@ func equalFieldType(out any, kind reflect.Kind, key, aliasTag string) bool {
 	return false
 }
 
-// Get content type from content type header
+// FilterFlags returns the media type value by trimming any parameters from a Content-Type header.
 func FilterFlags(content string) string {
 	for i, char := range content {
 		if char == ' ' || char == ';' {

binder/msgpack.go

@@ -24,10 +24,14 @@ func (b *MsgPackBinding) Reset() {
 	b.MsgPackDecoder = nil
 }
 
+// UnimplementedMsgpackMarshal panics to signal that a Msgpack marshaler must
+// be configured before MsgPack support can be used.
 func UnimplementedMsgpackMarshal(_ any) ([]byte, error) {
 	panic("Must explicit setup Msgpack, please check docs: https://docs.gofiber.io/next/guide/advance-format#msgpack")
 }
 
+// UnimplementedMsgpackUnmarshal panics to signal that a Msgpack unmarshaler
+// must be configured before MsgPack support can be used.
 func UnimplementedMsgpackUnmarshal(_ []byte, _ any) error {
 	panic("Must explicit setup Msgpack, please check docs: https://docs.gofiber.io/next/guide/advance-format#msgpack")
 }

binder/uri.go

@@ -1,6 +1,6 @@
 package binder
 
-// uriBinding is the URI binder for URI parameters.
+// URIBinding is the binder implementation for populating values from route parameters.
 type URIBinding struct{}
 
 // Name returns the binding name.

client/request.go

@@ -134,15 +134,18 @@ type pair struct {
 	v []string
 }
 
+// Len implements sort.Interface and reports the number of tracked keys.
 func (p *pair) Len() int {
 	return len(p.k)
 }
 
+// Swap implements sort.Interface and swaps the entries at the provided indices.
 func (p *pair) Swap(i, j int) {
 	p.k[i], p.k[j] = p.k[j], p.k[i]
 	p.v[i], p.v[j] = p.v[j], p.v[i]
 }
 
+// Less implements sort.Interface and orders entries lexicographically by key.
 func (p *pair) Less(i, j int) bool {
 	return p.k[i] < p.k[j]
 }

ctx.go

@@ -70,7 +70,8 @@ type DefaultCtx struct {
 	matched       bool                 // Non use route matched
 }
 
-// TLSHandler object
+// TLSHandler hosts the callback hooks Fiber invokes while negotiating TLS
+// connections, including optional client certificate lookups.
 type TLSHandler struct {
 	clientHelloInfo *tls.ClientHelloInfo
 }
@@ -149,11 +150,7 @@ func (*DefaultCtx) Done() <-chan struct{} {
 	return nil
 }
 
-// If Done is not yet closed, Err returns nil.
-// If Done is closed, Err returns a non-nil error explaining why:
-// context.DeadlineExceeded if the context's deadline passed,
-// or context.Canceled if the context was canceled for some other reason.
-// After Err returns a non-nil error, successive calls to Err return the same error.
+// Err mirrors context.Err, returning nil until cancellation and then the terminal error value.
 //
 // Due to current limitations in how fasthttp works, Err operates as a nop.
 // See: https://github.com/valyala/fasthttp/issues/965#issuecomment-777268945