Mesa (master): gallium: added comment for pipe_reference() return value

[Brian Paul]

Module: Mesa
Branch: master
Commit: 4430a05a3a65c411996a923d1051bb7879204a53
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=4430a05a3a65c411996a923d1051bb7879204a53

Author: Brian Paul <brianp at vmware.com>
Date:   Fri Dec 11 16:50:25 2009 -0700

gallium: added comment for pipe_reference() return value

---

 src/gallium/include/pipe/p_refcnt.h |    1 +
 1 files changed, 1 insertions(+), 0 deletions(-)

diff --git a/src/gallium/include/pipe/p_refcnt.h b/src/gallium/include/pipe/p_refcnt.h
index e252f55..c1c7415 100644
--- 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)