Add comment

notify-rs · Jan 14, 2023 · d765321 · d765321
1 parent 3439340
commit d765321
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/notify/src/kqueue.rs b/notify/src/kqueue.rs
@@ -302,6 +302,9 @@ impl EventLoop {
         Ok(())
     }
 
+    /// Adds a single watch to the kqueue.
+    ///
+    /// The caller of this function must call `self.kqueue.watch()` afterwards to register the new watch.
     fn add_single_watch(&mut self, path: PathBuf, is_recursive: bool) -> Result<()> {
         let event_filter = EventFilter::EVFILT_VNODE;
         let filter_flags = FilterFlag::NOTE_DELETE