From: Martin Tournoij <martin@arp242.net>
Date: Wed, 10 Aug 2022 17:03:32 +0000 (+0200)
Subject: Clarify doc comment on WatchList() (#499)
X-Git-Tag: v1.7.2~61
X-Git-Url: https://go.fuhry.dev/?a=commitdiff_plain;h=666da9ca04f071bd0134ce52f95e11577085fe25;p=fsnotify.git

Clarify doc comment on WatchList() (#499)
---

diff --git a/backend_inotify.go b/backend_inotify.go
index 7444191..855e654 100644
--- a/backend_inotify.go
+++ b/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()
diff --git a/backend_kqueue.go b/backend_kqueue.go
index feb5705..409c645 100644
--- a/backend_kqueue.go
+++ b/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()
diff --git a/backend_windows.go b/backend_windows.go
index c52272b..a254053 100644
--- a/backend_windows.go
+++ b/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()
diff --git a/mkdoc.zsh b/mkdoc.zsh
index fd44b25..b6dff6e 100755
--- a/mkdoc.zsh
+++ b/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