📒 docs: Auto generated framework documentation

addon/retry/README.md

@@ -71,6 +71,8 @@ retry.NewExponentialBackoff()
 ## Custom Config
 
 ```go
+import "time"
+
 retry.NewExponentialBackoff(retry.Config{
     InitialInterval: 2 * time.Second,
     MaxBackoffTime:  64 * time.Second,

docs/addon/retry.md

@@ -1,90 +1,45 @@
+<!-- Code generated by gomarkdoc. DO NOT EDIT -->
+
 ---
 id: retry
 ---
 
-# Retry Addon
-
-The Retry addon for [Fiber](https://github.com/gofiber/fiber) retries failed network operations using exponential
-backoff with jitter. It repeatedly invokes a function until it succeeds or the maximum number of attempts is
-exhausted. Jitter at each step breaks client synchronization and helps avoid collisions. If all attempts fail, the
-addon returns an error.
-
-## Table of Contents
 
-- [Signatures](#signatures)
-- [Examples](#examples)
-- [Default Config](#default-config)
-- [Custom Config](#custom-config)
-- [Config](#config)
-- [Default Config Example](#default-config-example)
-
-## Signatures
+# retry
 
 ```go
-func NewExponentialBackoff(config ...retry.Config) *retry.ExponentialBackoff
+import "github.com/gofiber/fiber/v3/addon/retry"
 ```
 
-## Examples
+## Index
 
-```go
-package main
-
-import (
-    "fmt"
-
-    "github.com/gofiber/fiber/v3/addon/retry"
-    "github.com/gofiber/fiber/v3/client"
-)
-
-func main() {
-    expBackoff := retry.NewExponentialBackoff(retry.Config{})
-
-    // Local variables used inside Retry
-    var resp *client.Response
-    var err error
-
-    // Retry a network request and return an error to signal another attempt
-    err = expBackoff.Retry(func() error {
-        client := client.New()
-        resp, err = client.Get("https://gofiber.io")
-        if err != nil {
-            return fmt.Errorf("GET gofiber.io failed: %w", err)
-        }
-        if resp.StatusCode() != 200 {
-            return fmt.Errorf("GET gofiber.io did not return 200 OK")
-        }
-        return nil
-    })
-
-    // If all retries failed, panic
-    if err != nil {
-        panic(err)
-    }
-    fmt.Printf("GET gofiber.io succeeded with status code %d\n", resp.StatusCode())
-}
-```
+- [Variables](<#variables>)
+- [type Config](<#Config>)
+- [type ExponentialBackoff](<#ExponentialBackoff>)
+  - [func NewExponentialBackoff\(config ...Config\) \*ExponentialBackoff](<#NewExponentialBackoff>)
+  - [func \(e \*ExponentialBackoff\) Retry\(f func\(\) error\) error](<#ExponentialBackoff.Retry>)
 
-## Default Config
 
-```go
-retry.NewExponentialBackoff()
-```
+## Variables
 
-## Custom Config
+<a name="DefaultConfig"></a>DefaultConfig is the default config for retry.
 
 ```go
-retry.NewExponentialBackoff(retry.Config{
-    InitialInterval: 2 * time.Second,
-    MaxBackoffTime:  64 * time.Second,
+var DefaultConfig = Config{
+    InitialInterval: 1 * time.Second,
+    MaxBackoffTime:  32 * time.Second,
     Multiplier:      2.0,
-    MaxRetryCount:   15,
-})
+    MaxRetryCount:   10,
+    // contains filtered or unexported fields
+}
 ```
 
-## Config
+<a name="Config"></a>
+## type Config
+
+Config defines the config for addon.
 
 ```go
-// Config defines the config for addon.
 type Config struct {
     // InitialInterval defines the initial time interval for backoff algorithm.
     //
@@ -107,18 +62,49 @@
     //
     // Optional. Default: 10
     MaxRetryCount int
+    // contains filtered or unexported fields
 }
 ```
 
-## Default Config Example
+<a name="ExponentialBackoff"></a>
+## type ExponentialBackoff
+
+ExponentialBackoff is a retry mechanism for retrying some calls.
 
 ```go
-// DefaultConfig is the default config for retry.
-var DefaultConfig = Config{
-    InitialInterval: 1 * time.Second,
-    MaxBackoffTime:  32 * time.Second,
-    Multiplier:      2.0,
-    MaxRetryCount:   10,
-    currentInterval: 1 * time.Second,
+type ExponentialBackoff struct {
+    // InitialInterval is the initial time interval for backoff algorithm.
+    InitialInterval time.Duration
+
+    // MaxBackoffTime is the maximum time duration for backoff algorithm. It limits
+    // the maximum sleep time.
+    MaxBackoffTime time.Duration
+
+    // Multiplier is a multiplier number of the backoff algorithm.
+    Multiplier float64
+
+    // MaxRetryCount is the maximum number of retry count.
+    MaxRetryCount int
+    // contains filtered or unexported fields
 }
 ```
+
+<a name="NewExponentialBackoff"></a>
+### func NewExponentialBackoff
+
+```go
+func NewExponentialBackoff(config ...Config) *ExponentialBackoff
+```
+
+NewExponentialBackoff creates a ExponentialBackoff with default values.
+
+<a name="ExponentialBackoff.Retry"></a>
+### func \(\*ExponentialBackoff\) Retry
+
+```go
+func (e *ExponentialBackoff) Retry(f func() error) error
+```
+
+Retry is the core logic of the retry mechanism. If the calling function returns nil as an error, then the Retry method is terminated with returning nil. Otherwise, if all function calls are returned error, then the method returns this error.
+
+Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)