add docs for exported types

weynsee · May 19, 2015 · 65b3276 · 65b3276
1 parent 0be6d35
commit 65b3276
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 0 deletions.
diff --git a/cli/init_command.go b/cli/init_command.go
@@ -8,12 +8,14 @@ import (
 	"strings"
 )
 
+// InitCommand will initialize a PhraseApp config file named .phrase in the current directory.
 type InitCommand struct {
 	Ui     mcli.Ui
 	Config *Config
 	API    *phrase.Client
 }
 
+// Run executes the init command.
 func (c *InitCommand) Run(args []string) int {
 	cmdFlags := flag.NewFlagSet("init", flag.ContinueOnError)
 	cmdFlags.Usage = func() { c.Ui.Output(c.Help()) }
@@ -55,6 +57,7 @@ func (c *InitCommand) Run(args []string) int {
 	return 0
 }
 
+// Help displays available options for the init command.
 func (c *InitCommand) Help() string {
 	helpText := `
 	Usage: phrase init [options]
@@ -76,6 +79,7 @@ func (c *InitCommand) Help() string {
 	return strings.TrimSpace(helpText)
 }
 
+// Synopsis displays a synopsis of the init command.
 func (c *InitCommand) Synopsis() string {
 	return "Initializes a phrase project"
 }
diff --git a/cli/pull_command.go b/cli/pull_command.go
@@ -12,6 +12,7 @@ import (
 	"time"
 )
 
+// PullCommand will download locale files from PhraseApp.
 type PullCommand struct {
 	Ui     mcli.Ui
 	Config *Config
@@ -24,6 +25,7 @@ const (
 	defaultDownloadFormat = "yml"
 )
 
+// Run executes the pull command.
 func (c *PullCommand) Run(args []string) int {
 	cmdFlags := flag.NewFlagSet("pull", flag.ContinueOnError)
 	cmdFlags.Usage = func() { c.Ui.Output(c.Help()) }
@@ -162,6 +164,7 @@ func (c *PullCommand) selectLocales(locales []string) ([]phrase.Locale, error) {
 	}
 }
 
+// Help displays available options for the pull command.
 func (c *PullCommand) Help() string {
 	helpText := `
 	Usage: phrase pull [options] [LOCALE]
@@ -183,6 +186,7 @@ func (c *PullCommand) Help() string {
 	return strings.TrimSpace(helpText)
 }
 
+// Synopsis displays a synopsis of the pull command.
 func (c *PullCommand) Synopsis() string {
 	return "Download the translation files in the current project"
 }
diff --git a/cli/push_command.go b/cli/push_command.go
@@ -14,6 +14,7 @@ import (
 	"sync"
 )
 
+// PullCommand will upload locale files to PhraseApp.
 type PushCommand struct {
 	Ui     mcli.Ui
 	Config *Config
@@ -24,6 +25,7 @@ var defaultLocaleFolder = filepath.Join("config", "locales")
 
 var validTag = regexp.MustCompile(`\A[a-zA-Z0-9\_\-\.]+\z`)
 
+// Run executes the push command.
 func (c *PushCommand) Run(args []string) int {
 	cmdFlags := flag.NewFlagSet("push", flag.ContinueOnError)
 	cmdFlags.Usage = func() { c.Ui.Output(c.Help()) }
@@ -224,6 +226,7 @@ func listFiles(dir string, list []string, recurse bool) []string {
 	return list
 }
 
+// Help displays available options for the push command.
 func (c *PushCommand) Help() string {
 	helpText := `
 	Usage: phrase push [options] [FILE|DIRECTORY]
@@ -245,6 +248,7 @@ func (c *PushCommand) Help() string {
 	return strings.TrimSpace(helpText)
 }
 
+// Synopsis displays a synopsis of the push command.
 func (c *PushCommand) Synopsis() string {
 	return "Upload the translation files in the current project to PhraseApp"
 }
diff --git a/cli/tags_command.go b/cli/tags_command.go
@@ -8,12 +8,14 @@ import (
 	"strings"
 )
 
+// TagsCommand will display all tags in the current project.
 type TagsCommand struct {
 	Ui     mcli.Ui
 	Config *Config
 	API    *phrase.Client
 }
 
+// Run executes the tags command.
 func (c *TagsCommand) Run(args []string) int {
 	list := false
 	cmdFlags := flag.NewFlagSet("tags", flag.ContinueOnError)
@@ -35,6 +37,7 @@ func (c *TagsCommand) Run(args []string) int {
 	return 0
 }
 
+// Help displays available options for the tags command.
 func (c *TagsCommand) Help() string {
 	helpText := `
 	Usage: phrase tags [options]
@@ -49,6 +52,7 @@ func (c *TagsCommand) Help() string {
 	return strings.TrimSpace(helpText)
 }
 
+// Synopsis displays a synopsis of the tags command.
 func (c *TagsCommand) Synopsis() string {
 	return "List all the tags in the current project"
 }