From b3cc16857115ba993e558efa6cca6fa58e9c9cc3 Mon Sep 17 00:00:00 2001
From: Julien Fontanet <julien.fontanet@isonoe.net>
Date: Fri, 8 Apr 2022 10:57:16 +0200
Subject: [PATCH] docs(xapi/watchObject): explicit behavior and param

---
 @xen-orchestra/xapi/index.js | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/@xen-orchestra/xapi/index.js b/@xen-orchestra/xapi/index.js
index 2b0dadecb..ef71291b9 100644
--- a/@xen-orchestra/xapi/index.js
+++ b/@xen-orchestra/xapi/index.js
@@ -163,6 +163,10 @@ class Xapi extends Base {
     return stopWatch
   }
 
+  // Watch an object for changes.
+  //
+  // Predicate can be either an id, a UUID, an opaque reference or a
+  // function.
   watchObject(predicate, cb) {
     if (typeof predicate === 'function') {
       const genericWatchers = this._genericWatchers