aboutsummaryrefslogtreecommitdiff
path: root/cmd
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2023-04-01 16:11:24 +0700
committerShulhan <ms@kilabit.info>2023-04-01 16:15:08 +0700
commit3e188c30249222b58504ca87da66564b31f63d11 (patch)
treeb3a4b8ecb11e73d6304d587c97894f77acae9325 /cmd
parent482ff43bdd061d194875920f43ae335a69053946 (diff)
downloadrescached-3e188c30249222b58504ca87da66564b31f63d11.tar.xz
all: update go doc comments
While at it, use "_" for unused parameter on methods.
Diffstat (limited to 'cmd')
-rw-r--r--cmd/rescached/main.go6
-rw-r--r--cmd/resolver/doc.go2
-rw-r--r--cmd/resolver/main.go5
-rw-r--r--cmd/resolverbench/main.go1
4 files changed, 10 insertions, 4 deletions
diff --git a/cmd/rescached/main.go b/cmd/rescached/main.go
index 6173943..e94be5e 100644
--- a/cmd/rescached/main.go
+++ b/cmd/rescached/main.go
@@ -1,6 +1,12 @@
// SPDX-FileCopyrightText: 2018 M. Shulhan <ms@kilabit.info>
// SPDX-License-Identifier: GPL-3.0-or-later
+// Program rescached server that caching internet name and address on local
+// memory for speeding up DNS resolution.
+//
+// Rescached primary goal is only to caching DNS queries and answers, used by
+// personal or small group of users, to minimize unneeded traffic to outside
+// network.
package main
import (
diff --git a/cmd/resolver/doc.go b/cmd/resolver/doc.go
index 03222c0..8396dec 100644
--- a/cmd/resolver/doc.go
+++ b/cmd/resolver/doc.go
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: GPL-3.0-or-later
/*
-Command resolver is command line interface (CLI) for DNS and rescached server.
+Program resolver is command line interface (CLI) for DNS and rescached server.
# SYNOPSIS
diff --git a/cmd/resolver/main.go b/cmd/resolver/main.go
index c8e5fe7..848d679 100644
--- a/cmd/resolver/main.go
+++ b/cmd/resolver/main.go
@@ -36,9 +36,8 @@ const (
subCmdUpdate = "update"
)
-var (
- Usage string // Contains usage of program, overwritten by build.
-)
+// Usage of program, overwritten by build.
+var Usage string
func main() {
var (
diff --git a/cmd/resolverbench/main.go b/cmd/resolverbench/main.go
index 3e35e24..0821d29 100644
--- a/cmd/resolverbench/main.go
+++ b/cmd/resolverbench/main.go
@@ -1,6 +1,7 @@
// SPDX-FileCopyrightText: 2018 M. Shulhan <ms@kilabit.info>
// SPDX-License-Identifier: GPL-3.0-or-later
+// Program resolverbench program to benchmark DNS server or resolver.
package main
import (