better docs

Signed-off-by: Jeff Carr <[email protected]>

1 files changed, 12 insertions, 2 deletions

diff --git a/args.go b/args.go
index c63905e..fbfda77 100644
--- a/args.go
+++ b/args.go
@@ -6,7 +6,10 @@ import (
 
 var argGui ArgsGui
 
-// This struct can be used with the go-arg package
+/*
+This struct can be used with the go-arg package. These
+are the generic default command line arguments for the 'GUI' package
+*/
 type ArgsGui struct {
 	GuiPlugin  string `arg:"--gui" help:"Use this gui toolkit [andlabs,gocui,nocui]"`
 	GuiVerbose bool   `arg:"--gui-verbose" help:"enable all logging"`
@@ -14,7 +17,14 @@ type ArgsGui struct {
 	// GuiStdout  bool   `arg:"--gui-stdout" help:"send STDOUT and STDERR to /tmp/go-gui.log"`
 }
 
-// returns the toolkit
+/*
+used for command line options.
+This allows you to control the toolkit settings from the command line
+
+	--debugger      # opens the debugger
+	--gui andlabs   # loads the GTK toolkit on linux or Cocoa on mac
+	--gui gocui     # runs your program in the terminal in ncurses-like mode
+*/
 func ArgToolkit() string {
 	return argGui.GuiPlugin
 }