summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUli Schlachter <psychon@znc.in>2021-05-22 21:43:22 +0200
committerPovilas Kanapickas <povilas@radix.lt>2021-09-20 18:40:08 +0000
commita503167f751ba77e6819df568b7f5042d2baa9c9 (patch)
tree0224e105c7400a6f919d1b62ac3fdca272776fd8
parent3c76c0579ffa521af41f78ee937b1337581da985 (diff)
downloadxcb-libxcb-a503167f751ba77e6819df568b7f5042d2baa9c9.tar.gz
Improve/fix docs for reply fds functions
Fixes: https://gitlab.freedesktop.org/xorg/lib/libxcb/-/issues/56 Signed-off-by: Uli Schlachter <psychon@znc.in>
-rw-r--r--src/c_client.py5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/c_client.py b/src/c_client.py
index dfb5864..fd256f0 100644
--- a/src/c_client.py
+++ b/src/c_client.py
@@ -2611,9 +2611,10 @@ def _c_reply_fds(self, name):
_h(' * @param c The connection')
_h(' * @param reply The reply')
_h(' *')
- _h(' * Returns the array of reply fds of the request asked by')
+ _h(' * Returns a pointer to the array of reply fds of the reply.')
_h(' *')
- _h(' * The returned value must be freed by the caller using free().')
+ _h(' * The returned value points into the reply and must not be free().')
+ _h(' * The fds are not managed by xcb. You must close() them before freeing the reply.')
_h(' */')
_c('')
_hc('int *')