From: TORRI Vincent Date: Tue, 27 Feb 2007 12:35:02 +0000 (+0100) Subject: add the first step toward the documentation of the request/reply functions. The argum... X-Git-Url: http://git.demorecorder.com/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4a60950b7433eb41e08cb0c74dc8ced8f92fd78a;p=free-sw%2Fxcb%2Flibxcb add the first step toward the documentation of the request/reply functions. The arguments of the requests are not found yet. Josh, can you look at it ? --- diff --git a/src/c-client.xsl b/src/c-client.xsl index 3e2e849..d7a0eb9 100644 --- a/src/c-client.xsl +++ b/src/c-client.xsl @@ -342,6 +342,24 @@ authorization from the authors. + /** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + + * This form can be used only if the request will not cause + * a reply to be generated. Any returned error will be + * saved for handling by xcb_request_check(). + + + * This form can be used only if the request will cause + * a reply to be generated. Any returned error will be + * placed in the event queue. + + */ + /** + * Return the reply + * @param c The connection + * @param cookie The cookie + * @param e The xcb_generic_error_t supplied + * + * Returns the reply of the request asked by + * + * The parameter @p e supplied to this function must be NULL if + * _unchecked(). is used. + * Otherwise, it stores the error if any. + */