gallium: added comment for pipe_reference() return value

diff --git a/src/gallium/include/pipe/p_refcnt.h b/src/gallium/include/pipe/p_refcnt.h
index e252f5590065a1c5920a9b1fe4ca3cb589d3e5d5..c1c7415e023f974370b09e95ab67d129e952a63d 100644 (file)
--- a/src/gallium/include/pipe/p_refcnt.h
+++ b/src/gallium/include/pipe/p_refcnt.h
@@ -62,6 +62,7 @@ pipe_is_referenced(struct pipe_reference *reference)
  * Update reference counting.
  * The old thing pointed to, if any, will be unreferenced.
  * Both 'ptr' and 'reference' may be NULL.
+ * \return TRUE if the object's refcount hits zero and should be destroyed.
  */
 static INLINE boolean
 pipe_reference(struct pipe_reference *ptr, struct pipe_reference *reference)