doc: clarify uv_loop_t.data field lifetime

Fixes #1503
2014-09-30 09:14:56 +02:00 · 2014-09-30 09:14:56 +02:00 · 00df3ec75b
commit 00df3ec75b
parent 9486e462fc
1 changed files with 3 additions and 1 deletions
--- a/docs/src/loop.rst
+++ b/docs/src/loop.rst
@ -38,7 +38,9 @@ Public members

 .. c:member:: void* uv_loop_t.data

-    Space for user-defined arbitrary data. libuv does not use this field.
+    Space for user-defined arbitrary data. libuv does not use this field. libuv does, however,
+    initialize it to NULL in :c:func:`uv_loop_init`, and it poisons the value (on debug builds)
+    on :c:func:`uv_loop_close`.


 API