Clarify doc comment on WatchList() (#499)

backend_inotify.go

@@ -312,7 +312,7 @@ func (w *Watcher) Remove(name string) error {
 	return nil
 }
 
-// WatchList returns the directories and files that are being monitered.
+// WatchList returns all paths added with Add() (and are not yet removed).
 func (w *Watcher) WatchList() []string {
 	w.mu.Lock()
 	defer w.mu.Unlock()

backend_kqueue.go

@@ -332,7 +332,7 @@ func (w *Watcher) Remove(name string) error {
 	return nil
 }
 
-// WatchList returns the directories and files that are being monitered.
+// WatchList returns all paths added with Add() (and are not yet removed).
 func (w *Watcher) WatchList() []string {
 	w.mu.Lock()
 	defer w.mu.Unlock()

backend_windows.go

@@ -252,7 +252,7 @@ func (w *Watcher) Remove(name string) error {
 	return <-in.reply
 }
 
-// WatchList returns the directories and files that are being monitered.
+// WatchList returns all paths added with Add() (and are not yet removed).
 func (w *Watcher) WatchList() []string {
 	w.mu.Lock()
 	defer w.mu.Unlock()

mkdoc.zsh

@@ -119,6 +119,11 @@ close=$(<<EOF
 EOF
 )
 
+watchlist=$(<<EOF
+// WatchList returns all paths added with Add() (and are not yet removed).
+EOF
+)
+
 events=$(<<EOF
 	// Events sends the filesystem change events.
 	//
@@ -194,5 +199,6 @@ set-cmt '^func NewWatcher('                 $new
 set-cmt '^func (w \*Watcher) Add('          $add
 set-cmt '^func (w \*Watcher) Remove('       $remove
 set-cmt '^func (w \*Watcher) Close('        $close
+set-cmt '^func (w \*Watcher) WatchList('    $watchlist
 set-cmt '^[[:space:]]*Events *chan Event$'  $events
 set-cmt '^[[:space:]]*Errors *chan error$'  $errors