diff --git a/internal/alpine/alpine.go b/internal/alpine/alpine.go index d57c0bec..29b6410f 100644 --- a/internal/alpine/alpine.go +++ b/internal/alpine/alpine.go @@ -1,3 +1,4 @@ +// Package alpine defines a configurator to interact with the Alpine operating system. package alpine import ( diff --git a/internal/cli/cli.go b/internal/cli/cli.go index 26edc04b..c86ca9df 100644 --- a/internal/cli/cli.go +++ b/internal/cli/cli.go @@ -1,3 +1,4 @@ +// Package cli defines an interface CLI to run command line operations. package cli import ( diff --git a/internal/constants/constants.go b/internal/constants/constants.go new file mode 100644 index 00000000..0828edfc --- /dev/null +++ b/internal/constants/constants.go @@ -0,0 +1,3 @@ +// Package constants defines constants shared throughout the program. +// It also defines constant maps and slices using functions. +package constants diff --git a/internal/dns/loop.go b/internal/dns/loop.go index 90158990..15479207 100644 --- a/internal/dns/loop.go +++ b/internal/dns/loop.go @@ -1,3 +1,4 @@ +// Package dns defines interfaces to interact with DNS and DNS over TLS. package dns import ( diff --git a/internal/firewall/firewall.go b/internal/firewall/firewall.go index 7e70e6cf..e569b84d 100644 --- a/internal/firewall/firewall.go +++ b/internal/firewall/firewall.go @@ -1,3 +1,5 @@ +// Package firewall defines a configurator used to change the state +// of the firewall as well as do some light routing changes. package firewall import ( diff --git a/internal/healthcheck/health.go b/internal/healthcheck/health.go index e2b68886..0e5e6373 100644 --- a/internal/healthcheck/health.go +++ b/internal/healthcheck/health.go @@ -1,3 +1,4 @@ +// Package healthcheck defines the client and server side of the built in healthcheck. package healthcheck import ( diff --git a/internal/httpproxy/loop.go b/internal/httpproxy/loop.go index c4dee5cb..72d74275 100644 --- a/internal/httpproxy/loop.go +++ b/internal/httpproxy/loop.go @@ -1,3 +1,4 @@ +// Package httpproxy defines an interface to run an HTTP(s) proxy server. package httpproxy import ( diff --git a/internal/logging/splash.go b/internal/logging/splash.go index d286c70b..1f4eadea 100644 --- a/internal/logging/splash.go +++ b/internal/logging/splash.go @@ -1,3 +1,4 @@ +// Package logging defines helper functions for logging. package logging import ( diff --git a/internal/models/models.go b/internal/models/models.go new file mode 100644 index 00000000..b0123b9f --- /dev/null +++ b/internal/models/models.go @@ -0,0 +1,3 @@ +// Package models defines struct with methods shared across other +// packages in the program. +package models diff --git a/internal/openvpn/openvpn.go b/internal/openvpn/openvpn.go index 6148bb6c..4fe52f10 100644 --- a/internal/openvpn/openvpn.go +++ b/internal/openvpn/openvpn.go @@ -1,3 +1,5 @@ +// Package openvpn defines interfaces to interact with openvpn +// and run it in a stateful loop. package openvpn import ( diff --git a/internal/provider/provider.go b/internal/provider/provider.go index f5b5f10f..0ae17fb2 100644 --- a/internal/provider/provider.go +++ b/internal/provider/provider.go @@ -1,3 +1,4 @@ +// Package provider defines interfaces to interact with each VPN provider. package provider import ( diff --git a/internal/publicip/publicip.go b/internal/publicip/publicip.go index 9d3a9e6a..87e1994f 100644 --- a/internal/publicip/publicip.go +++ b/internal/publicip/publicip.go @@ -1,3 +1,4 @@ +// Package publicip defines interfaces to get your public IP address. package publicip import ( diff --git a/internal/routing/routing.go b/internal/routing/routing.go index 4a2c34d0..97f54843 100644 --- a/internal/routing/routing.go +++ b/internal/routing/routing.go @@ -1,3 +1,4 @@ +// Package routing defines interfaces to interact with the ip routes using NETLINK. package routing import ( diff --git a/internal/server/server.go b/internal/server/server.go index 564dbaa7..e2124aca 100644 --- a/internal/server/server.go +++ b/internal/server/server.go @@ -1,3 +1,4 @@ +// Package server defines an interface to run the HTTP control server. package server import ( diff --git a/internal/shadowsocks/loop.go b/internal/shadowsocks/loop.go index e57ef57f..8db9b63e 100644 --- a/internal/shadowsocks/loop.go +++ b/internal/shadowsocks/loop.go @@ -1,3 +1,4 @@ +// Package shadowsocks defines interfaces to configure and run a Shadowsocks server. package shadowsocks import ( diff --git a/internal/storage/storage.go b/internal/storage/storage.go index 894b0ac7..1a30fc92 100644 --- a/internal/storage/storage.go +++ b/internal/storage/storage.go @@ -1,3 +1,4 @@ +// Package storage defines interfaces to interact with the files persisted such as the list of servers. package storage import ( diff --git a/internal/unix/unix.go b/internal/unix/unix.go index df6de678..95b6852b 100644 --- a/internal/unix/unix.go +++ b/internal/unix/unix.go @@ -1,3 +1,5 @@ +// Package unix defines interfaces to interact with Unix related objects. +// Its primary use is to be used in tests. package unix import sysunix "golang.org/x/sys/unix" diff --git a/internal/updater/updater.go b/internal/updater/updater.go index fe8562f1..9226af2f 100644 --- a/internal/updater/updater.go +++ b/internal/updater/updater.go @@ -1,3 +1,4 @@ +// Package updater implements update mechanisms for each VPN provider servers. package updater import ( diff --git a/internal/version/version.go b/internal/version/version.go index b654774e..8885c89e 100644 --- a/internal/version/version.go +++ b/internal/version/version.go @@ -1,3 +1,5 @@ +// Package version implements functions to fetch information from +// Github on newer version of the program available. package version import (