doc: add documentation to all exported methods

Author: ccoVeille

encoding.go

@@ -49,7 +49,7 @@ type DecoderRegistry interface {
 	Decoder(format string) (Decoder, error)
 }
 
-// [CodecRegistry] combines [EncoderRegistry] and [DecoderRegistry] interfaces.
+// CodecRegistry combines [EncoderRegistry] and [DecoderRegistry] interfaces.
 type CodecRegistry interface {
 	EncoderRegistry
 	DecoderRegistry

internal/encoding/dotenv/codec.go

@@ -15,6 +15,7 @@ const keyDelimiter = "_"
 // (commonly called as dotenv format).
 type Codec struct{}
 
+// Encode encodes a map[string]any into a dotenv byte slice.
 func (Codec) Encode(v map[string]any) ([]byte, error) {
 	flattened := map[string]any{}
 
@@ -40,6 +41,7 @@ func (Codec) Encode(v map[string]any) ([]byte, error) {
 	return buf.Bytes(), nil
 }
 
+// Decode decodes a dotenv byte slice into a map[string]any.
 func (Codec) Decode(b []byte, v map[string]any) error {
 	var buf bytes.Buffer
 

internal/encoding/json/codec.go

@@ -7,11 +7,13 @@ import (
 // Codec implements the encoding.Encoder and encoding.Decoder interfaces for JSON encoding.
 type Codec struct{}
 
+// Encode encodes a map[string]any into a JSON byte slice.
 func (Codec) Encode(v map[string]any) ([]byte, error) {
 	// TODO: expose prefix and indent in the Codec as setting?
 	return json.MarshalIndent(v, "", "  ")
 }
 
+// Decode decodes a JSON byte slice into a map[string]any.
 func (Codec) Decode(b []byte, v map[string]any) error {
 	return json.Unmarshal(b, &v)
 }

internal/encoding/toml/codec.go

@@ -7,10 +7,12 @@ import (
 // Codec implements the encoding.Encoder and encoding.Decoder interfaces for TOML encoding.
 type Codec struct{}
 
+// Encode encodes a map[string]any into a TOML byte slice.
 func (Codec) Encode(v map[string]any) ([]byte, error) {
 	return toml.Marshal(v)
 }
 
+// Decode decodes a TOML byte slice into a map[string]any.
 func (Codec) Decode(b []byte, v map[string]any) error {
 	return toml.Unmarshal(b, &v)
 }

internal/encoding/yaml/codec.go

@@ -5,10 +5,12 @@ import "go.yaml.in/yaml/v3"
 // Codec implements the encoding.Encoder and encoding.Decoder interfaces for YAML encoding.
 type Codec struct{}
 
+// Encode encodes a map[string]any into a YAML byte slice.
 func (Codec) Encode(v map[string]any) ([]byte, error) {
 	return yaml.Marshal(v)
 }
 
+// Decode decodes a YAML byte slice into a map[string]any.
 func (Codec) Decode(b []byte, v map[string]any) error {
 	return yaml.Unmarshal(b, &v)
 }

internal/features/bind_struct.go

@@ -2,4 +2,5 @@
 
 package features
 
+// BindStruct is a feature flag for enabling/disabling the config binding to structs.
 const BindStruct = true

internal/features/bind_struct_default.go

@@ -2,4 +2,5 @@
 
 package features
 
+// BindStruct is a feature flag for enabling/disabling the config binding to structs.
 const BindStruct = false

internal/features/finder.go

@@ -2,4 +2,5 @@
 
 package features
 
+// Finder is a feature flag for enabling/disabling the config finder.
 const Finder = true

internal/features/finder_default.go

@@ -2,4 +2,5 @@
 
 package features
 
+// Finder is a feature flag for enabling/disabling the config finder.
 const Finder = false

remote.go

@@ -21,6 +21,7 @@ type remoteConfigFactory interface {
 	WatchChannel(rp RemoteProvider) (<-chan *RemoteResponse, chan bool)
 }
 
+// RemoteResponse represents a response from a remote configuration provider.
 type RemoteResponse struct {
 	Value []byte
 	Error error
@@ -93,6 +94,14 @@ func AddRemoteProvider(provider, endpoint, path string) error {
 	return v.AddRemoteProvider(provider, endpoint, path)
 }
 
+// AddRemoteProvider adds a remote configuration source.
+// Remote Providers are searched in the order they are added.
+// provider is a string value: "etcd", "etcd3", "consul", "firestore" or "nats" are currently supported.
+// endpoint is the url.  etcd requires http://ip:port, consul requires ip:port, nats requires nats://ip:port
+// path is the path in the k/v store to retrieve configuration
+// To retrieve a config file called myapp.json from /configs/myapp.json
+// you should set path to /configs and set config name (SetConfigName()) to
+// "myapp".
 func (v *Viper) AddRemoteProvider(provider, endpoint, path string) error {
 	if !slices.Contains(SupportedRemoteProviders, provider) {
 		return UnsupportedRemoteProviderError(provider)
@@ -126,6 +135,16 @@ func AddSecureRemoteProvider(provider, endpoint, path, secretkeyring string) err
 	return v.AddSecureRemoteProvider(provider, endpoint, path, secretkeyring)
 }
 
+// AddSecureRemoteProvider adds a remote configuration source.
+// Secure Remote Providers are searched in the order they are added.
+// provider is a string value: "etcd", "etcd3", "consul", "firestore" or "nats" are currently supported.
+// endpoint is the url.  etcd requires http://ip:port  consul requires ip:port
+// secretkeyring is the filepath to your openpgp secret keyring.  e.g. /etc/secrets/myring.gpg
+// path is the path in the k/v store to retrieve configuration
+// To retrieve a config file called myapp.json from /configs/myapp.json
+// you should set path to /configs and set config name (SetConfigName()) to
+// "myapp".
+// Secure Remote Providers are implemented with github.com/sagikazarmark/crypt.
 func (v *Viper) AddSecureRemoteProvider(provider, endpoint, path, secretkeyring string) error {
 	if !slices.Contains(SupportedRemoteProviders, provider) {
 		return UnsupportedRemoteProviderError(provider)
@@ -159,15 +178,21 @@ func (v *Viper) providerPathExists(p *defaultRemoteProvider) bool {
 // and read it in the remote configuration registry.
 func ReadRemoteConfig() error { return v.ReadRemoteConfig() }
 
+// ReadRemoteConfig attempts to get configuration from a remote source
+// and read it in the remote configuration registry.
 func (v *Viper) ReadRemoteConfig() error {
 	return v.getKeyValueConfig()
 }
 
+// WatchRemoteConfig updates configuration from available remote providers.
 func WatchRemoteConfig() error { return v.WatchRemoteConfig() }
+
+// WatchRemoteConfig updates configuration from available remote providers.
 func (v *Viper) WatchRemoteConfig() error {
 	return v.watchKeyValueConfig()
 }
 
+// WatchRemoteConfigOnChannel updates configuration from available remote providers.
 func (v *Viper) WatchRemoteConfigOnChannel() error {
 	return v.watchKeyValueConfigOnChannel()
 }