More plugin docs and improve doc formatting

internal/action/infocomplete.go

@@ -197,7 +197,7 @@ func OptionValueComplete(b *buffer.Buffer) ([]string, []string) {
 	return completions, suggestions
 }
 
-// OptionComplete autocompletes options
+// PluginCmdComplete autocompletes the plugin command
 func PluginCmdComplete(b *buffer.Buffer) ([]string, []string) {
 	c := b.GetActiveCursor()
 	input, argstart := buffer.GetArg(b)
@@ -253,51 +253,28 @@ func PluginComplete(b *buffer.Buffer) ([]string, []string) {
 	return completions, suggestions
 }
 
-// // MakeCompletion registers a function from a plugin for autocomplete commands
-// func MakeCompletion(function string) Completion {
-// 	pluginCompletions = append(pluginCompletions, LuaFunctionComplete(function))
-// 	return Completion(-len(pluginCompletions))
-// }
+// PluginNameComplete completes with the names of loaded plugins
+// func PluginNameComplete(b *buffer.Buffer) ([]string, []string) {
+// 	c := b.GetActiveCursor()
+// 	input, argstart := buffer.GetArg(b)
 //
-// // PluginComplete autocompletes from plugin function
-// func PluginComplete(complete Completion, input string) (chosen string, suggestions []string) {
-// 	idx := int(-complete) - 1
-//
-// 	if len(pluginCompletions) <= idx {
-// 		return "", nil
-// 	}
-// 	suggestions = pluginCompletions[idx](input)
-//
-// 	if len(suggestions) == 1 {
-// 		chosen = suggestions[0]
-// 	}
-// 	return
-// }
-//
-// // PluginCmdComplete completes with possible choices for the `> plugin` command
-// func PluginCmdComplete(input string) (chosen string, suggestions []string) {
-// 	for _, cmd := range []string{"install", "remove", "search", "update", "list"} {
-// 		if strings.HasPrefix(cmd, input) {
-// 			suggestions = append(suggestions, cmd)
-// 		}
-// 	}
-//
-// 	if len(suggestions) == 1 {
-// 		chosen = suggestions[0]
-// 	}
-// 	return chosen, suggestions
-// }
-//
-// // PluginnameComplete completes with the names of loaded plugins
-// func PluginNameComplete(input string) (chosen string, suggestions []string) {
-// 	for _, pp := range GetAllPluginPackages() {
+// 	var suggestions []string
+// 	for _, pp := range config.GetAllPluginPackages(nil) {
 // 		if strings.HasPrefix(pp.Name, input) {
 // 			suggestions = append(suggestions, pp.Name)
 // 		}
 // 	}
 //
-// 	if len(suggestions) == 1 {
-// 		chosen = suggestions[0]
+// 	sort.Strings(suggestions)
+// 	completions := make([]string, len(suggestions))
+// 	for i := range suggestions {
+// 		completions[i] = util.SliceEndStr(suggestions[i], c.X-argstart)
 // 	}
-// 	return chosen, suggestions
+// 	return completions, suggestions
+// }
+
+// // MakeCompletion registers a function from a plugin for autocomplete commands
+// func MakeCompletion(function string) Completion {
+// 	pluginCompletions = append(pluginCompletions, LuaFunctionComplete(function))
+// 	return Completion(-len(pluginCompletions))
 // }

internal/buffer/message.go

@@ -13,13 +13,19 @@ const (
 	MTError
 )
 
+// Message represents the information for a gutter message
 type Message struct {
-	Msg        string
+	// The Msg iteslf
+	Msg string
+	// Start and End locations for the message
 	Start, End Loc
-	Kind       MsgType
-	Owner      string
+	// The Kind stores the message type
+	Kind MsgType
+	// The Owner of the message
+	Owner string
 }
 
+// NewMessage creates a new gutter message
 func NewMessage(owner string, msg string, start, end Loc, kind MsgType) *Message {
 	return &Message{
 		Msg:   msg,
@@ -30,6 +36,7 @@ func NewMessage(owner string, msg string, start, end Loc, kind MsgType) *Message
 	}
 }
 
+// NewMessageAtLine creates a new gutter message at a given line
 func NewMessageAtLine(owner string, msg string, line int, kind MsgType) *Message {
 	start := Loc{-1, line - 1}
 	end := start

internal/config/rtfiles.go

@@ -42,6 +42,7 @@ func init() {
 	realFiles = make([][]RuntimeFile, NumTypes)
 }
 
+// NewRTFiletype creates a new RTFiletype
 func NewRTFiletype() int {
 	NumTypes++
 	allFiles = append(allFiles, []RuntimeFile{})

internal/util/lua.go

@@ -4,6 +4,8 @@ import (
 	"unicode/utf8"
 )
 
+// LuaRuneAt is a helper function for lua plugins to return the rune
+// at an index within a string
 func LuaRuneAt(str string, runeidx int) string {
 	i := 0
 	for len(str) > 0 {
@@ -20,6 +22,7 @@ func LuaRuneAt(str string, runeidx int) string {
 	return ""
 }
 
+// LuaGetLeadingWhitespace returns the leading whitespace of a string (used by lua plugins)
 func LuaGetLeadingWhitespace(s string) string {
 	ws := []byte{}
 	for len(s) > 0 {
@@ -35,6 +38,7 @@ func LuaGetLeadingWhitespace(s string) string {
 	return string(ws)
 }
 
+// LuaIsWordChar returns true if the first rune in a string is a word character
 func LuaIsWordChar(s string) bool {
 	r, _ := utf8.DecodeRuneInString(s)
 	return IsWordChar(r)

internal/util/util.go

@@ -418,6 +418,7 @@ func ParseSpecial(s string) string {
 	return strings.Replace(s, "\\t", "\t", -1)
 }
 
+// String converts a byte array to a string (for lua plugins)
 func String(s []byte) string {
 	return string(s)
 }