docs: add doc comments to packages

[abemedia]

No description provided.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (aa8806a) 98.48% compared to head (d68cfc5) 98.48%.

❗ Current head d68cfc5 differs from pull request most recent head 7b76b6e. Consider uploading reports for the commit 7b76b6e to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #203   +/-   ##
=======================================
  Coverage   98.48%   98.48%           
=======================================
  Files          24       24           
  Lines         728      728           
=======================================
  Hits          717      717           
  Misses          6        6           
  Partials        5        5           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

Benchmark Results

.

goos: linux
goarch: amd64
pkg: github.com/abemedia/go-don
cpu: AMD EPYC 7763 64-Core Processor                
                         │   before    │               after                │
                         │   sec/op    │   sec/op     vs base               │
Handler/Request-4          247.0n ± 1%   245.6n ± 3%       ~ (p=0.304 n=10)
Handler/RequestPointer-4   278.7n ± 0%   273.0n ± 1%  -2.01% (p=0.001 n=10)
geomean                    262.3n        259.0n       -1.28%

                         │   before   │                after                │
                         │    B/op    │    B/op     vs base                 │
Handler/Request-4          24.00 ± 0%   24.00 ± 0%       ~ (p=1.000 n=10) ¹
Handler/RequestPointer-4   24.00 ± 0%   24.00 ± 0%       ~ (p=1.000 n=10) ¹
geomean                    24.00        24.00       +0.00%
¹ all samples are equal

                         │   before   │                after                │
                         │ allocs/op  │ allocs/op   vs base                 │
Handler/Request-4          1.000 ± 0%   1.000 ± 0%       ~ (p=1.000 n=10) ¹
Handler/RequestPointer-4   1.000 ± 0%   1.000 ± 0%       ~ (p=1.000 n=10) ¹
geomean                    1.000        1.000       +0.00%
¹ all samples are equal

encoding/json

goos: linux
goarch: amd64
pkg: github.com/abemedia/go-don/encoding/json
cpu: AMD EPYC 7763 64-Core Processor                
              │   before    │               after                │
              │   sec/op    │   sec/op     vs base               │
JSON/Decode-4   80.50n ± 2%   80.90n ± 1%       ~ (p=0.305 n=10)
JSON/Encode-4   116.1n ± 0%   116.3n ± 1%       ~ (p=0.207 n=10)
geomean         96.70n        97.02n       +0.33%

              │   before   │                after                │
              │    B/op    │    B/op     vs base                 │
JSON/Decode-4   16.00 ± 0%   16.00 ± 0%       ~ (p=1.000 n=10) ¹
JSON/Encode-4   32.00 ± 0%   32.00 ± 0%       ~ (p=1.000 n=10) ¹
geomean         22.63        22.63       +0.00%
¹ all samples are equal

              │   before   │                after                │
              │ allocs/op  │ allocs/op   vs base                 │
JSON/Decode-4   1.000 ± 0%   1.000 ± 0%       ~ (p=1.000 n=10) ¹
JSON/Encode-4   2.000 ± 0%   2.000 ± 0%       ~ (p=1.000 n=10) ¹
geomean         1.414        1.414       +0.00%
¹ all samples are equal

encoding/msgpack

goos: linux
goarch: amd64
pkg: github.com/abemedia/go-don/encoding/msgpack
cpu: AMD EPYC 7763 64-Core Processor                
                 │   before    │               after                │
                 │   sec/op    │   sec/op     vs base               │
Msgpack/Decode-4   296.0n ± 2%   297.1n ± 1%  +0.37% (p=0.022 n=10)
Msgpack/Encode-4   284.0n ± 0%   284.1n ± 2%       ~ (p=0.468 n=10)
geomean            289.9n        290.5n       +0.20%

                 │   before   │                after                │
                 │    B/op    │    B/op     vs base                 │
Msgpack/Decode-4   51.00 ± 0%   51.00 ± 0%       ~ (p=1.000 n=10) ¹
Msgpack/Encode-4   128.0 ± 0%   128.0 ± 0%       ~ (p=1.000 n=10) ¹
geomean            80.80        80.80       +0.00%
¹ all samples are equal

                 │   before   │                after                │
                 │ allocs/op  │ allocs/op   vs base                 │
Msgpack/Decode-4   2.000 ± 0%   2.000 ± 0%       ~ (p=1.000 n=10) ¹
Msgpack/Encode-4   3.000 ± 0%   3.000 ± 0%       ~ (p=1.000 n=10) ¹
geomean            2.449        2.449       +0.00%
¹ all samples are equal

encoding/protobuf

goos: linux
goarch: amd64
pkg: github.com/abemedia/go-don/encoding/protobuf
cpu: AMD EPYC 7763 64-Core Processor                
                  │   before    │               after                │
                  │   sec/op    │   sec/op     vs base               │
Protobuf/Decode-4   154.2n ± 1%   154.1n ± 0%       ~ (p=0.278 n=10)
Protobuf/Encode-4   105.7n ± 0%   105.9n ± 0%       ~ (p=0.445 n=10)
geomean             127.7n        127.8n       +0.06%

                  │   before   │                after                │
                  │    B/op    │    B/op     vs base                 │
Protobuf/Decode-4   3.000 ± 0%   3.000 ± 0%       ~ (p=1.000 n=10) ¹
Protobuf/Encode-4   5.000 ± 0%   5.000 ± 0%       ~ (p=1.000 n=10) ¹
geomean             3.873        3.873       +0.00%
¹ all samples are equal

                  │   before   │                after                │
                  │ allocs/op  │ allocs/op   vs base                 │
Protobuf/Decode-4   1.000 ± 0%   1.000 ± 0%       ~ (p=1.000 n=10) ¹
Protobuf/Encode-4   1.000 ± 0%   1.000 ± 0%       ~ (p=1.000 n=10) ¹
geomean             1.000        1.000       +0.00%
¹ all samples are equal

encoding/text

goos: linux
goarch: amd64
pkg: github.com/abemedia/go-don/encoding/text
cpu: AMD EPYC 7763 64-Core Processor                
              │   before    │               after                │
              │   sec/op    │   sec/op     vs base               │
Text/Decode-4   11.78n ± 2%   11.79n ± 2%       ~ (p=0.589 n=10)
Text/Encode-4   35.28n ± 0%   35.41n ± 2%  +0.38% (p=0.006 n=10)
geomean         20.39n        20.43n       +0.23%

              │    before    │                after                │
              │     B/op     │    B/op     vs base                 │
Text/Decode-4   0.000 ± 0%     0.000 ± 0%       ~ (p=1.000 n=10) ¹
Text/Encode-4   16.00 ± 0%     16.00 ± 0%       ~ (p=1.000 n=10) ¹
geomean                    ²               +0.00%                ²
¹ all samples are equal
² summaries must be >0 to compute geomean

              │    before    │                after                │
              │  allocs/op   │ allocs/op   vs base                 │
Text/Decode-4   0.000 ± 0%     0.000 ± 0%       ~ (p=1.000 n=10) ¹
Text/Encode-4   1.000 ± 0%     1.000 ± 0%       ~ (p=1.000 n=10) ¹
geomean                    ²               +0.00%                ²
¹ all samples are equal
² summaries must be >0 to compute geomean

encoding/toml

goos: linux
goarch: amd64
pkg: github.com/abemedia/go-don/encoding/toml
cpu: AMD EPYC 7763 64-Core Processor                
              │   before    │               after                │
              │   sec/op    │   sec/op     vs base               │
TOML/Decode-4   4.538µ ± 1%   4.520µ ± 1%       ~ (p=0.256 n=10)
TOML/Encode-4   1.291µ ± 1%   1.302µ ± 1%  +0.89% (p=0.001 n=10)
geomean         2.420µ        2.426µ       +0.25%

              │    before    │                 after                 │
              │     B/op     │     B/op      vs base                 │
TOML/Decode-4   11.59Ki ± 0%   11.59Ki ± 0%       ~ (p=1.000 n=10) ¹
TOML/Encode-4     752.0 ± 0%     752.0 ± 0%       ~ (p=1.000 n=10) ¹
geomean         2.918Ki        2.918Ki       +0.00%
¹ all samples are equal

              │   before   │                after                │
              │ allocs/op  │ allocs/op   vs base                 │
TOML/Decode-4   36.00 ± 0%   36.00 ± 0%       ~ (p=1.000 n=10) ¹
TOML/Encode-4   16.00 ± 0%   16.00 ± 0%       ~ (p=1.000 n=10) ¹
geomean         24.00        24.00       +0.00%
¹ all samples are equal

encoding/xml

goos: linux
goarch: amd64
pkg: github.com/abemedia/go-don/encoding/xml
cpu: AMD EPYC 7763 64-Core Processor                
             │   before    │               after                │
             │   sec/op    │   sec/op     vs base               │
XML/Decode-4   1.926µ ± 3%   1.932µ ± 1%       ~ (p=0.645 n=10)
XML/Encode-4   1.400µ ± 1%   1.405µ ± 1%  +0.36% (p=0.004 n=10)
geomean        1.642µ        1.647µ       +0.32%

             │    before    │                 after                 │
             │     B/op     │     B/op      vs base                 │
XML/Decode-4   1.070Ki ± 0%   1.070Ki ± 0%       ~ (p=1.000 n=10) ¹
XML/Encode-4   4.359Ki ± 0%   4.359Ki ± 0%       ~ (p=1.000 n=10) ¹
geomean        2.160Ki        2.160Ki       +0.00%
¹ all samples are equal

             │   before   │                after                │
             │ allocs/op  │ allocs/op   vs base                 │
XML/Decode-4   22.00 ± 0%   22.00 ± 0%       ~ (p=1.000 n=10) ¹
XML/Encode-4   8.000 ± 0%   8.000 ± 0%       ~ (p=1.000 n=10) ¹
geomean        13.27        13.27       +0.00%
¹ all samples are equal

encoding/yaml

goos: linux
goarch: amd64
pkg: github.com/abemedia/go-don/encoding/yaml
cpu: AMD EPYC 7763 64-Core Processor                
              │   before    │               after                │
              │   sec/op    │   sec/op     vs base               │
YAML/Decode-4   4.822µ ± 2%   4.776µ ± 2%       ~ (p=0.078 n=10)
YAML/Encode-4   2.993µ ± 1%   3.028µ ± 2%  +1.17% (p=0.000 n=10)
geomean         3.799µ        3.803µ       +0.10%

              │    before    │                 after                 │
              │     B/op     │     B/op      vs base                 │
YAML/Decode-4   6.586Ki ± 0%   6.586Ki ± 0%       ~ (p=1.000 n=10) ¹
YAML/Encode-4   6.556Ki ± 0%   6.556Ki ± 0%       ~ (p=1.000 n=10) ¹
geomean         6.571Ki        6.571Ki       +0.00%
¹ all samples are equal

              │   before   │                after                │
              │ allocs/op  │ allocs/op   vs base                 │
YAML/Decode-4   41.00 ± 0%   41.00 ± 0%       ~ (p=1.000 n=10) ¹
YAML/Encode-4   19.00 ± 0%   19.00 ± 0%       ~ (p=1.000 n=10) ¹
geomean         27.91        27.91       +0.00%
¹ all samples are equal