From c090c8d194376a00198e5f600a5721f7f735c658 Mon Sep 17 00:00:00 2001
From: LeoTindall <lfstindall@gmail.com>
Date: Sun, 20 May 2018 12:11:06 -0400
Subject: [PATCH] Improve documentation of stddialogs

---
 stddialogs.go | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/stddialogs.go b/stddialogs.go
index 0ff8a01..560bb1f 100644
--- a/stddialogs.go
+++ b/stddialogs.go
@@ -5,7 +5,8 @@ package ui
 // #include "ui.h"
 import "C"
 
-// TODO
+// MsgBoxError opens a modal dialog box with graphical error hinting and returns when the
+// user acknowledges the message.
 func MsgBoxError(w *Window, title string, description string) {
 	ctitle := C.CString(title)
 	defer freestr(ctitle)
@@ -14,6 +15,7 @@ func MsgBoxError(w *Window, title string, description string) {
 	C.uiMsgBoxError(w.w, ctitle, cdescription)
 }
 
+// OpenFile opens a modal allowing the user to select a path to an existing file.
 func OpenFile(w *Window) string {
 	cname := C.uiOpenFile(w.w)
 	if cname == nil {
@@ -23,6 +25,8 @@ func OpenFile(w *Window) string {
 	return C.GoString(cname)
 }
 
+
+// SaveFile opens a modal allowing the user to select a path to a new or existing file.
 func SaveFile(w *Window) string {
 	cname := C.uiSaveFile(w.w)
 	if cname == nil {
@@ -31,7 +35,8 @@ func SaveFile(w *Window) string {
 	defer C.uiFreeText(cname)
 	return C.GoString(cname)
 }
-
+// MsgBox opens a generic modal dialog box and returns when the user acknowledges the
+// message.
 func MsgBox(w *Window, title string, description string) {
 	ctitle := C.CString(title)
 	defer freestr(ctitle)