Add comments for golint

buffer.go

@@ -14,6 +14,7 @@ type undoT struct {
 	text string
 }
 
+// Buffer is ReadLine's internal data structure
 type Buffer struct {
 	*Editor
 	Buffer         []Moji
@@ -26,6 +27,7 @@ type Buffer struct {
 	pending        string
 }
 
+// ViewWidth returns the cell-width screen can show in the one-line.
 func (B *Buffer) ViewWidth() WidthT {
 	return WidthT(B.termWidth) - WidthT(B.topColumn) - forbiddenWidth
 }
@@ -72,9 +74,8 @@ func (B *Buffer) insertString(pos int, s string) _Range {
 	return _Range(list)
 }
 
-// Insert String :s at :pos (Do not update screen)
-// returns
-//    count of rune
+// InsertString inserts string s at pos (Do not update screen)
+// It returns the count of runes
 func (B *Buffer) InsertString(pos int, s string) int {
 	return len(B.insertString(pos, s))
 }
@@ -116,10 +117,12 @@ func (B *Buffer) ResetViewStart() {
 	}
 }
 
+// GetWidthBetween returns the width between start and end
 func (B *Buffer) GetWidthBetween(from int, to int) WidthT {
 	return _Range(B.Buffer[from:to]).Width()
 }
 
+// SubString returns the readline string between start and end
 func (B *Buffer) SubString(start, end int) string {
 	return moji2string(B.Buffer[start:end])
 }
@@ -128,8 +131,11 @@ func (B Buffer) String() string {
 	return moji2string(B.Buffer)
 }
 
+// Delimiters means the quationmarks. The whitespace enclosed by them
+// are not treat as parameters separator.
 var Delimiters = "\"'"
 
+// CurrentWordTop returns the position of the current word the cursor exists
 func (B *Buffer) CurrentWordTop() (wordTop int) {
 	wordTop = -1
 	quotedchar := '\000'
@@ -155,6 +161,7 @@ func (B *Buffer) CurrentWordTop() (wordTop int) {
 	return wordTop
 }
 
+// CurrentWord returns the current word the cursor exists and word's position
 func (B *Buffer) CurrentWord() (string, int) {
 	start := B.CurrentWordTop()
 	return B.SubString(start, B.Cursor), start

getkey.go

@@ -6,6 +6,7 @@ import (
 	"github.com/zetamatta/go-readline-ny/internal/github.com/mattn/go-tty"
 )
 
+// KeyGetter is the interface from which the ReadLine can read console input
 type KeyGetter interface {
 	Raw() (func() error, error)
 	ReadRune() (rune, error)
@@ -56,6 +57,8 @@ type _DefaultTty struct {
 	*tty.TTY
 }
 
+// NewDefaultTty returns the instance for KeyGetter, which is the customized
+// version of go-tty.TTY
 func NewDefaultTty() (KeyGetter, error) {
 	tty1, err := tty.Open()
 	if err != nil {

history.go

@@ -6,6 +6,8 @@ import (
 	"io"
 )
 
+// IHistory is the interface ReadLine can use as container for history.
+// It can be set to Editor.History field
 type IHistory interface {
 	Len() int
 	At(int) string
@@ -19,10 +21,12 @@ func (*_EmptyHistory) Len() int { return 0 }
 // At always returns empty-string because the receiver is dummy.
 func (*_EmptyHistory) At(int) string { return "" }
 
+// KeyMap is the class for key-bindings
 type KeyMap struct {
 	KeyMap map[string]KeyFuncT
 }
 
+// Editor is the main class to hold the parameter for ReadLine
 type Editor struct {
 	KeyMap
 	History       IHistory