added more comments and fixed formatting

netclient/daemon/common.go

@@ -7,6 +7,7 @@ import (
 	"github.com/gravitl/netmaker/netclient/config"
 )
 
+// InstallDaemon - Calls the correct function to install the netclient as a daemon service on the given operating system.
 func InstallDaemon(cfg config.ClientConfig) error {
 	os := runtime.GOOS
 	var err error

netclient/daemon/macos.go

@@ -10,6 +10,7 @@ import (
 
 const MAC_SERVICE_NAME = "com.gravitl.netclient"
 
+// SetupMacDaemon - Creates a daemon service from the netclient under LaunchAgents for MacOS
 func SetupMacDaemon(interval string) error {
 
 	if !ncutils.FileExists("/etc/netclient/netclient") {
@@ -37,6 +38,7 @@ func SetupMacDaemon(interval string) error {
 	return err
 }
 
+// CleanupMac - Removes the netclient checkin daemon from LaunchDaemons
 func CleanupMac() {
 	_, err := ncutils.RunCmd("launchctl unload /Library/LaunchDaemons/"+MAC_SERVICE_NAME+".plist", true)
 	if ncutils.FileExists("/Library/LaunchDaemons/" + MAC_SERVICE_NAME + ".plist") {
@@ -49,6 +51,7 @@ func CleanupMac() {
 	os.RemoveAll(ncutils.GetNetclientPath())
 }
 
+// CreateMacService - Creates the mac service file for LaunchDaemons
 func CreateMacService(servicename string, interval string) error {
 	_, err := os.Stat("/Library/LaunchDaemons")
 	if os.IsNotExist(err) {
@@ -66,6 +69,7 @@ func CreateMacService(servicename string, interval string) error {
 	return err
 }
 
+// MacDaemonString - the file contents for the mac netclient daemon service (launchdaemon)
 func MacDaemonString(interval string) string {
 	return fmt.Sprintf(`<?xml version='1.0' encoding='UTF-8'?>
 <!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\" >
@@ -94,6 +98,7 @@ func MacDaemonString(interval string) string {
 `, interval)
 }
 
+// MacTemplateData - struct to represent the mac service
 type MacTemplateData struct {
 	Label    string
 	Interval string

netclient/ncutils/netclientutils.go

@@ -239,6 +239,7 @@ func GetLocalIP(localrange string) (string, error) {
 	return local, nil
 }
 
+//GetNetworkIPMask - Pulls the netmask out of the network
 func GetNetworkIPMask(networkstring string) (string, string, error) {
 	ip, ipnet, err := net.ParseCIDR(networkstring)
 	if err != nil {
@@ -467,7 +468,7 @@ func stringAfter(original string, substring string) string {
 	return original[adjustedPosition:]
 }
 
-//ShortenString - Brings string down to specified length. Stops names from being too long
+// ShortenString - Brings string down to specified length. Stops names from being too long
 func ShortenString(input string, length int) string {
 	output := input
 	if len(input) > length {
@@ -476,7 +477,7 @@ func ShortenString(input string, length int) string {
 	return output
 }
 
-//DNSFormatString - Formats a string with correct usage for DNS
+// DNSFormatString - Formats a string with correct usage for DNS
 func DNSFormatString(input string) string {
 	reg, err := regexp.Compile("[^a-zA-Z0-9-]+")
 	if err != nil {
@@ -486,7 +487,7 @@ func DNSFormatString(input string) string {
 	return reg.ReplaceAllString(input, "")
 }
 
-//GetHostname - Gets hostname of machine
+// GetHostname - Gets hostname of machine
 func GetHostname() string {
 	hostname, err := os.Hostname()
 	if err != nil {
@@ -498,7 +499,7 @@ func GetHostname() string {
 	return hostname
 }
 
-//CheckUID - Checks to make sure user has root privileges
+// CheckUID - Checks to make sure user has root privileges
 func CheckUID() {
 	// start our application
 	out, err := RunCmd("id -u", true)

netclient/wireguard/mac.go

@@ -161,7 +161,7 @@ func deleteInterface(iface string, realIface string) error {
 	return err
 }
 
-// upInterface -
+// upInterface - bring up the interface with ifconfig
 func upInterface(iface string) error {
 	var err error
 	_, err = ncutils.RunCmd("ifconfig "+iface+" up", true)