Maintenance: package comments

internal/alpine/alpine.go

@@ -1,3 +1,4 @@
+// Package alpine defines a configurator to interact with the Alpine operating system.
 package alpine
 
 import (

internal/cli/cli.go

@@ -1,3 +1,4 @@
+// Package cli defines an interface CLI to run command line operations.
 package cli
 
 import (

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

internal/dns/loop.go

@@ -1,3 +1,4 @@
+// Package dns defines interfaces to interact with DNS and DNS over TLS.
 package dns
 
 import (

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 (

internal/healthcheck/health.go

@@ -1,3 +1,4 @@
+// Package healthcheck defines the client and server side of the built in healthcheck.
 package healthcheck
 
 import (

internal/httpproxy/loop.go

@@ -1,3 +1,4 @@
+// Package httpproxy defines an interface to run an HTTP(s) proxy server.
 package httpproxy
 
 import (

internal/logging/splash.go

@@ -1,3 +1,4 @@
+// Package logging defines helper functions for logging.
 package logging
 
 import (

internal/models/models.go

@@ -0,0 +1,3 @@
+// Package models defines struct with methods shared across other
+// packages in the program.
+package models

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 (

internal/provider/provider.go

@@ -1,3 +1,4 @@
+// Package provider defines interfaces to interact with each VPN provider.
 package provider
 
 import (

internal/publicip/publicip.go

@@ -1,3 +1,4 @@
+// Package publicip defines interfaces to get your public IP address.
 package publicip
 
 import (

internal/routing/routing.go

@@ -1,3 +1,4 @@
+// Package routing defines interfaces to interact with the ip routes using NETLINK.
 package routing
 
 import (

internal/server/server.go

@@ -1,3 +1,4 @@
+// Package server defines an interface to run the HTTP control server.
 package server
 
 import (

internal/shadowsocks/loop.go

@@ -1,3 +1,4 @@
+// Package shadowsocks defines interfaces to configure and run a Shadowsocks server.
 package shadowsocks
 
 import (

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 (

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"

internal/updater/updater.go

@@ -1,3 +1,4 @@
+// Package updater implements update mechanisms for each VPN provider servers.
 package updater
 
 import (

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 (