[Xcb] [PATCH] Add doxygen documentation to functions in xcbext.h

Josh Triplett josh at joshtriplett.org
Tue Feb 25 08:19:09 PST 2014


On Tue, Feb 25, 2014 at 03:56:05PM +0100, Uli Schlachter wrote:
> Signed-off-by: Uli Schlachter <psychon at znc.in>

Reviewed-by: Josh Triplett <josh at joshtriplett.org>

>  src/xcbext.h | 107 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++---
>  1 file changed, 103 insertions(+), 4 deletions(-)
> 
> Josh wrote that xcb_send_request() and especially its "negative array indices"
> need to be documented better, so here it is.

Thank you!

> --- a/src/xcbext.h
> +++ b/src/xcbext.h
> @@ -58,11 +58,56 @@ enum xcb_send_request_flags_t {
>      XCB_REQUEST_REPLY_FDS = 1 << 3
>  };
>  
> +/**
> + * @brief Send a request to the server.
> + * @param c: The connection to the X server.
> + * @param flags: A combination of flags from the xcb_send_request_flags_t enumeration.
> + * @param iovec: The base of the data to be sent.

"vector", not "iovec".

Also, I'd suggest including a brief version of the note about using
negative indexes here as well:

@param vector: Data to send; must have two iovecs before start for internal use.

- Josh Triplett


More information about the Xcb mailing list