From 1fa92de07e2a69ea38aacc03c2331922c583a412 Mon Sep 17 00:00:00 2001
From: Tom Limoncelli <tlimoncelli@stackoverflow.com>
Date: Tue, 7 May 2024 14:47:28 -0400
Subject: [PATCH] CHORE: Linting and comment-fixing (#2937)

---
 build/generate/featureMatrix.go | 6 +++---
 commands/zonecache.go           | 1 +
 documentation/SUMMARY.md        | 1 +
 models/domain.go                | 2 ++
 models/record.go                | 1 +
 models/unknown.go               | 1 +
 pkg/rfc4183/mode.go             | 5 +++++
 7 files changed, 14 insertions(+), 3 deletions(-)

diff --git a/build/generate/featureMatrix.go b/build/generate/featureMatrix.go
index 6297c3f90..b786de97f 100644
--- a/build/generate/featureMatrix.go
+++ b/build/generate/featureMatrix.go
@@ -80,7 +80,7 @@ func matrixData() *FeatureMatrix {
 		DomainModifierAlias  = "[`ALIAS`](language-reference/domain-modifiers/ALIAS.md)"
 		DomainModifierCaa    = "[`CAA`](language-reference/domain-modifiers/CAA.md)"
 		DomainModifierDnssec = "[`AUTODNSSEC`](language-reference/domain-modifiers/AUTODNSSEC_ON.md)"
-		DomainModifierHttps  = "[`HTTPS`](language-reference/domain-modifiers/HTTPS.md)"
+		DomainModifierHTTPS  = "[`HTTPS`](language-reference/domain-modifiers/HTTPS.md)"
 		DomainModifierLoc    = "[`LOC`](language-reference/domain-modifiers/LOC.md)"
 		DomainModifierNaptr  = "[`NAPTR`](language-reference/domain-modifiers/NAPTR.md)"
 		DomainModifierPtr    = "[`PTR`](language-reference/domain-modifiers/PTR.md)"
@@ -108,7 +108,7 @@ func matrixData() *FeatureMatrix {
 			DomainModifierAlias,
 			DomainModifierCaa,
 			DomainModifierDnssec,
-			DomainModifierHttps,
+			DomainModifierHTTPS,
 			DomainModifierLoc,
 			DomainModifierNaptr,
 			DomainModifierPtr,
@@ -212,7 +212,7 @@ func matrixData() *FeatureMatrix {
 			providers.CanUseDNSKEY,
 		)
 		setCapability(
-			DomainModifierHttps,
+			DomainModifierHTTPS,
 			providers.CanUseHTTPS,
 		)
 		setCapability(
diff --git a/commands/zonecache.go b/commands/zonecache.go
index 32aa4a8e1..0cfb70874 100644
--- a/commands/zonecache.go
+++ b/commands/zonecache.go
@@ -2,6 +2,7 @@ package commands
 
 import "github.com/StackExchange/dnscontrol/v4/providers"
 
+// NewZoneCache creates a zoneCache.
 func NewZoneCache() *zoneCache {
 	return &zoneCache{}
 }
diff --git a/documentation/SUMMARY.md b/documentation/SUMMARY.md
index c3dd24e63..1dec62ccd 100644
--- a/documentation/SUMMARY.md
+++ b/documentation/SUMMARY.md
@@ -25,6 +25,7 @@
   * [NewRegistrar](language-reference/top-level-functions/NewRegistrar.md)
   * [PANIC](language-reference/top-level-functions/PANIC.md)
   * [REV](language-reference/top-level-functions/REV.md)
+  * [REVCOMPAT](language-reference/top-level-functions/REVCOMPAT.md)
   * [getConfiguredDomains](language-reference/top-level-functions/getConfiguredDomains.md)
   * [require](language-reference/top-level-functions/require.md)
   * [require_glob](language-reference/top-level-functions/require_glob.md)
diff --git a/models/domain.go b/models/domain.go
index e4e6d38d4..e81ef9051 100644
--- a/models/domain.go
+++ b/models/domain.go
@@ -150,6 +150,7 @@ func (dc *DomainConfig) Punycode() error {
 	return nil
 }
 
+// StoreCorrections accumulates corrections in a thread-safe way.
 func (dc *DomainConfig) StoreCorrections(providerName string, corrections []*Correction) {
 	dc.pendingCorrectionsMutex.Lock()
 	defer dc.pendingCorrectionsMutex.Unlock()
@@ -171,6 +172,7 @@ func (dc *DomainConfig) StoreCorrections(providerName string, corrections []*Cor
 	}
 }
 
+// GetCorrections returns the accumulated corrections for providerName.
 func (dc *DomainConfig) GetCorrections(providerName string) []*Correction {
 	dc.pendingCorrectionsMutex.Lock()
 	defer dc.pendingCorrectionsMutex.Unlock()
diff --git a/models/record.go b/models/record.go
index 9d329858b..7270207b4 100644
--- a/models/record.go
+++ b/models/record.go
@@ -497,6 +497,7 @@ func (rc *RecordConfig) Key() RecordKey {
 	return RecordKey{rc.NameFQDN, t}
 }
 
+// GetSVCBValue returns the SVCB Key/Values as a list of Key/Values.
 func (rc *RecordConfig) GetSVCBValue() []dns.SVCBKeyValue {
 	record, err := dns.NewRR(fmt.Sprintf("%s %s %d %s %s", rc.NameFQDN, rc.Type, rc.SvcPriority, rc.target, rc.SvcParams))
 	if err != nil {
diff --git a/models/unknown.go b/models/unknown.go
index 71dfb696a..a4128d638 100644
--- a/models/unknown.go
+++ b/models/unknown.go
@@ -1,5 +1,6 @@
 package models
 
+// MakeUnknown turns an RecordConfig into an UNKNOWN type.
 func MakeUnknown(rc *RecordConfig, rtype string, contents string, origin string) error {
 	rc.Type = "UNKNOWN"
 	rc.UnknownTypeName = rtype
diff --git a/pkg/rfc4183/mode.go b/pkg/rfc4183/mode.go
index 02ef96ad3..587171c8c 100644
--- a/pkg/rfc4183/mode.go
+++ b/pkg/rfc4183/mode.go
@@ -8,6 +8,7 @@ import (
 var newmode bool
 var modeset bool
 
+// SetCompatibilityMode sets REV() compatibility mode.
 func SetCompatibilityMode(m string) error {
 	if modeset {
 		return fmt.Errorf("ERROR: REVCOMPAT() already set")
@@ -25,16 +26,20 @@ func SetCompatibilityMode(m string) error {
 	return nil
 }
 
+// IsRFC4183Mode returns true if REV() is in RFC4183 mode.
 func IsRFC4183Mode() bool {
 	return newmode
 }
 
 var warningNeeded bool = false
 
+// NeedsWarning sets that a future warning regarding RFC2317
+// compatibility is needed.
 func NeedsWarning() {
 	warningNeeded = true
 }
 
+// PrintWarning prints a warning if a warning related to RFC2317 is needed.
 func PrintWarning() {
 	if modeset {
 		// No warnings if REVCOMPAT() was used.