DOC: adds doc comments to exported functions

Adds comments to console.go exported functions.
This commit is contained in:
Ivan Marquez 2019-09-09 20:46:30 -04:00
parent 9ac1601463
commit 7f47791c7b
1 changed files with 5 additions and 1 deletions

View File

@ -2,10 +2,11 @@ package console
import ( import (
"fmt" "fmt"
ui "github.com/gizak/termui/v3"
"log" "log"
"os" "os"
"time" "time"
ui "github.com/gizak/termui/v3"
) )
const ( const (
@ -38,10 +39,13 @@ func Init() {
} }
} }
// Close function calls Close from termui package,
// which closes termbox-go
func Close() { func Close() {
ui.Close() ui.Close()
} }
// Exit function exits the program successfully
func Exit(message string) { func Exit(message string) {
if len(message) > 0 { if len(message) > 0 {
println(message) println(message)