diff --git a/key.go b/key.go index 90e33cd..ae4bf1a 100644 --- a/key.go +++ b/key.go @@ -99,7 +99,7 @@ func (k KeyType) String() (str string) { return "" } -// Control keys. I know we could do this with an iota, but the values are very +// Control keys. We could do this with an iota, but the values are very // specific, so we set the values explicitly to avoid any confusion. // // See also: diff --git a/mouse.go b/mouse.go index 928fec8..6cca0b6 100644 --- a/mouse.go +++ b/mouse.go @@ -2,6 +2,9 @@ package tea import "errors" +// MouseMsg contains information about a mouse event and are sent to a programs +// update function when mouse activity occurs. Note that the mouse must first +// be enabled via in order the mouse events to be received. type MouseMsg MouseEvent // MouseEvent represents a mouse event, which could be a click, a scroll wheel @@ -29,6 +32,7 @@ func (m MouseEvent) String() (s string) { // MouseEventType indicates the type of mouse event occurring. type MouseEventType int +// Mouse event types. const ( MouseUnknown MouseEventType = iota MouseLeft