Add exported function comments

Author: EdwinHoksberg

command/command.go

@@ -9,8 +9,11 @@ import (
 	"github.com/urfave/cli"
 )
 
+// Command holds data for the cli commands.
 type Command struct{}
 
+// GetLogger returns a logrus object according to any flags set
+// in the application parameters.
 func (c Command) GetLogger(cli *cli.Context) *log.Logger {
 	if cli.GlobalBool("quiet") {
 		logger, _ := test.NewNullLogger()
@@ -33,6 +36,7 @@ func (c Command) GetLogger(cli *cli.Context) *log.Logger {
 	return log.StandardLogger()
 }
 
+// GetBeanstalkdClient returns a client object for interacting with a beanstalkd server.
 func (c Command) GetBeanstalkdClient(cli *cli.Context) (*beanstalkd.BeanstalkdClient, error) {
 	// Build a connection string.
 	addr := fmt.Sprintf("%s:%d", cli.GlobalString("server"), cli.GlobalInt("port"))

command/flush.go

@@ -5,6 +5,7 @@ import (
 	"github.com/urfave/cli"
 )
 
+// Flush empties an entire tube of jobs.
 func (c *Command) Flush(cli *cli.Context) {
 	log := c.GetLogger(cli)
 

command/monitor.go

@@ -3,8 +3,9 @@ package command
 import (
 	"bytes"
 	"fmt"
-	"github.com/urfave/cli"
 	"time"
+
+	"github.com/urfave/cli"
 )
 
 var (
@@ -24,6 +25,7 @@ var (
 	}
 )
 
+// Monitor outputs a overview of server and tube statistics, repeated every second.
 func (c *Command) Monitor(cli *cli.Context) {
 	log := c.GetLogger(cli)
 

command/peek.go

@@ -2,9 +2,11 @@ package command
 
 import (
 	"fmt"
+
 	"github.com/urfave/cli"
 )
 
+// Peek displays the next job in the tube without removing it.
 func (c *Command) Peek(cli *cli.Context) {
 	log := c.GetLogger(cli)
 

command/pop.go

@@ -2,10 +2,12 @@ package command
 
 import (
 	"fmt"
+
 	"github.com/sirupsen/logrus"
 	"github.com/urfave/cli"
 )
 
+// Pop removes and displays a job from the selected tube.
 func (c *Command) Pop(cli *cli.Context) {
 	log := c.GetLogger(cli)
 

command/put.go

@@ -8,6 +8,7 @@ import (
 	"github.com/urfave/cli"
 )
 
+// Put adds a new job into a queue, from a string or reading from stdin.
 func (c *Command) Put(cli *cli.Context) {
 	log := c.GetLogger(cli)