Fix up minor things found by goreportcard.com

1 files changed, 13 insertions, 0 deletions

diff --git a/count.go b/count.go
index d061368..7b1f142 100644
--- a/count.go
+++ b/count.go
@@ -38,6 +38,7 @@ func countConv(sval string) (interface{}, error) {
 	return i, nil
 }
 
+// GetCount return the int value of a flag with the given name
 func (f *FlagSet) GetCount(name string) (int, error) {
 	val, err := f.getFlagType(name, "count", countConv)
 	if err != nil {
@@ -46,39 +47,51 @@ func (f *FlagSet) GetCount(name string) (int, error) {
 	return val.(int), nil
 }
 
+// CountVar defines a count flag with specified name, default value, and usage string.
+// The argument p points to an int variable in which to store the value of the flag.
+// A count flag will add 1 to its value evey time it is found on the command line
 func (f *FlagSet) CountVar(p *int, name string, usage string) {
 	f.CountVarP(p, name, "", usage)
 }
 
+// CountVarP is like CountVar only take a shorthand for the flag name.
 func (f *FlagSet) CountVarP(p *int, name, shorthand string, usage string) {
 	flag := f.VarPF(newCountValue(0, p), name, shorthand, usage)
 	flag.NoOptDefVal = "-1"
 }
 
+// CountVar like CountVar only the flag is placed on the CommandLine instead of a given flag set
 func CountVar(p *int, name string, usage string) {
 	CommandLine.CountVar(p, name, usage)
 }
 
+// CountVarP is like CountVar only take a shorthand for the flag name.
 func CountVarP(p *int, name, shorthand string, usage string) {
 	CommandLine.CountVarP(p, name, shorthand, usage)
 }
 
+// Count defines a count flag with specified name, default value, and usage string.
+// The return value is the address of an int variable that stores the value of the flag.
+// A count flag will add 1 to its value evey time it is found on the command line
 func (f *FlagSet) Count(name string, usage string) *int {
 	p := new(int)
 	f.CountVarP(p, name, "", usage)
 	return p
 }
 
+// CountP is like Count only takes a shorthand for the flag name.
 func (f *FlagSet) CountP(name, shorthand string, usage string) *int {
 	p := new(int)
 	f.CountVarP(p, name, shorthand, usage)
 	return p
 }
 
+// Count like Count only the flag is placed on the CommandLine isntead of a given flag set
 func Count(name string, usage string) *int {
 	return CommandLine.CountP(name, "", usage)
 }
 
+// CountP is like Count only takes a shorthand for the flag name.
 func CountP(name, shorthand string, usage string) *int {
 	return CommandLine.CountP(name, shorthand, usage)
 }