xf86drm: document drmDevicesEqual()HEADmain

I always need to double-check what the return value means when
using that function (since it's not a bool).

Signed-off-by: Simon Ser <contact@emersion.fr>

1 files changed, 5 insertions, 0 deletions

diff --git a/xf86drm.h b/xf86drm.h
index 2cb14156..6d91dfbd 100644
--- a/xf86drm.h
+++ b/xf86drm.h
@@ -926,6 +926,11 @@ extern int drmGetDeviceFromDevId(dev_t dev_id, uint32_t flags, drmDevicePtr *dev
  */
 extern int drmGetNodeTypeFromDevId(dev_t devid);
 
+/**
+ * Check if two drmDevice pointers represent the same DRM device.
+ *
+ * Returns 1 if the devices are equal, 0 otherwise.
+ */
 extern int drmDevicesEqual(drmDevicePtr a, drmDevicePtr b);
 
 extern int drmSyncobjCreate(int fd, uint32_t flags, uint32_t *handle);