Fix function comments based on best practices from Effective Go

customwidget.go

@@ -56,12 +56,12 @@ func (cw *CustomWidget) SizeHint() Size {
 	return Size{100, 100}
 }
 
-// deprecated, use PaintMode
+// ClearsBackground: deprecated, use PaintMode
 func (cw *CustomWidget) ClearsBackground() bool {
 	return cw.paintMode != PaintNormal
 }
 
-// deprecated, use SetPaintMode
+// SetClearsBackground: deprecated, use SetPaintMode
 func (cw *CustomWidget) SetClearsBackground(value bool) {
 	if value != cw.ClearsBackground() {
 		if value {

examples/tableview/tableview.go

@@ -39,13 +39,13 @@ func NewFooModel() *FooModel {
 	return m
 }
 
-// Called by the TableView from SetModel and every time the model publishes a
+// RowCount: Called by the TableView from SetModel and every time the model publishes a
 // RowsReset event.
 func (m *FooModel) RowCount() int {
 	return len(m.items)
 }
 
-// Called by the TableView when it needs the text to display for a given cell.
+// Value: Called by the TableView when it needs the text to display for a given cell.
 func (m *FooModel) Value(row, col int) interface{} {
 	item := m.items[row]
 
@@ -66,19 +66,19 @@ func (m *FooModel) Value(row, col int) interface{} {
 	panic("unexpected col")
 }
 
-// Called by the TableView to retrieve if a given row is checked.
+// Checked: Called by the TableView to retrieve if a given row is checked.
 func (m *FooModel) Checked(row int) bool {
 	return m.items[row].checked
 }
 
-// Called by the TableView when the user toggled the check box of a given row.
+// SetChecked: Called by the TableView when the user toggled the check box of a given row.
 func (m *FooModel) SetChecked(row int, checked bool) error {
 	m.items[row].checked = checked
 
 	return nil
 }
 
-// Called by the TableView to sort the model.
+// Sort: Called by the TableView to sort the model.
 func (m *FooModel) Sort(col int, order walk.SortOrder) error {
 	m.sortColumn, m.sortOrder = col, order
 

notifyicon.go

@@ -326,7 +326,7 @@ func (ni *NotifyIcon) MouseDown() *MouseEvent {
 	return ni.mouseDownPublisher.Event()
 }
 
-// MouseDown returns the event that is published when a mouse button is released
+// MouseUp returns the event that is published when a mouse button is released
 // while the cursor is over the NotifyIcon.
 func (ni *NotifyIcon) MouseUp() *MouseEvent {
 	return ni.mouseUpPublisher.Event()

numberedit.go

@@ -252,7 +252,7 @@ func (ne *NumberEdit) MinValue() float64 {
 	return ne.edit.minValue
 }
 
-// MinValue returns the maximum value the NumberEdit will accept.
+// MaxValue returns the maximum value the NumberEdit will accept.
 func (ne *NumberEdit) MaxValue() float64 {
 	return ne.edit.maxValue
 }
@@ -355,7 +355,7 @@ func (ne *NumberEdit) TextColor() Color {
 	return ne.edit.TextColor()
 }
 
-// TextColor sets the Color used to draw the text of the NumberEdit.
+// SetTextColor: sets the Color used to draw the text of the NumberEdit.
 func (ne *NumberEdit) SetTextColor(c Color) {
 	ne.edit.SetTextColor(c)
 }

window.go

@@ -646,7 +646,7 @@ func (wb *WindowBase) path() string {
 	return buf.String()
 }
 
-// WindowBase simply returns the receiver.
+// AsWindowBase: simply returns the receiver.
 func (wb *WindowBase) AsWindowBase() *WindowBase {
 	return wb
 }