Remove the 'int *error' out-parameter for xcb_poll_for_event.

[free-sw/xcb/libxcb] / src / xcb.h

diff --git a/src/xcb.h b/src/xcb.h
index ed4d4b9..4b5b349 100644 (file)
--- a/src/xcb.h
+++ b/src/xcb.h
@@ -35,18 +35,6 @@
 #include <stdint.h>
 #endif
 
-/* FIXME: these names conflict with those defined in Xmd.h. */
-#ifndef XMD_H
-typedef uint8_t  uint8_t;
-typedef uint8_t  uint8_t;
-typedef uint8_t  uint8_t;
-typedef uint16_t uint16_t;
-typedef uint32_t uint32_t;
-typedef int8_t   int8_t;
-typedef int16_t  int16_t;
-typedef int32_t  int32_t;
-#endif /* XMD_H */
-
 #include <sys/uio.h>
 #include <pthread.h>
 
@@ -60,7 +48,7 @@ extern "C" {
  */
 
 /**
- * @defgroup xcb__core_api_t XCB Core API
+ * @defgroup XCB_Core_API XCB Core API
  * @brief Core API of the XCB library.
  *
  * @{
@@ -157,7 +145,7 @@ typedef struct {
 /** XCB_NONE is the universal null resource or null atom parameter value for many core X requests */
 #define XCB_NONE 0L
 
-/** XCB_COPY_FROM_PARENT can be used for many CreateWindow parameters */
+/** XCB_COPY_FROM_PARENT can be used for many xcb_create_window parameters */
 #define XCB_COPY_FROM_PARENT 0L
 
 /** XCB_CURRENT_TIME can be used in most requests that take an xcb_timestamp_t */
@@ -236,12 +224,10 @@ xcb_generic_event_t *xcb_wait_for_event(xcb_connection_t *c);
  * Returns the next event or error from the server, if one is
  * available, or returns @c NULL otherwise. If no event is available, that
  * might be because an I/O error like connection close occurred while
- * attempting to read the next event. The @p error parameter is a
- * pointer to an int to be filled in with the I/O error status of the
- * operation. If @p error is @c NULL, terminates the application when an
- * I/O error occurs.
+ * attempting to read the next event, in which case the connection is
+ * shut down when this function returns.
  */
-xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c, int *error);
+xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c);
 
 /**
  * @brief Return the error for a request, or NULL if none can ever arrive.
@@ -249,11 +235,11 @@ xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c, int *error);
  * @param cookie: The request cookie.
  * @return The error for the request, or NULL if none can ever arrive.
  *
- * The xcb_void_cookie_t cookie supplied to this function must have resulted from
- * a call to XCB[RequestName]Checked().  This function will block until one of
- * two conditions happens.  If an error is received, it will be returned.  If
- * a reply to a subsequent request has already arrived, no error can arrive
- * for this request, so this function will return NULL.
+ * The xcb_void_cookie_t cookie supplied to this function must have resulted
+ * from a call to xcb_[request_name]_checked().  This function will block
+ * until one of two conditions happens.  If an error is received, it will be
+ * returned.  If a reply to a subsequent request has already arrived, no error
+ * can arrive for this request, so this function will return NULL.
  *
  * Note that this function will perform a sync if needed to ensure that the
  * sequence number will advance beyond that provided in cookie; this is a
@@ -278,7 +264,7 @@ typedef struct xcb_extension_t xcb_extension_t;  /**< Opaque structure used as k
  * This function is the primary interface to the "extension cache",
  * which caches reply information from QueryExtension
  * requests. Invoking this function may cause a call to
- * xcb_query_extension_t to retrieve extension information from the
+ * xcb_query_extension to retrieve extension information from the
  * server, and may block until extension data is received from the
  * server.
  *
@@ -294,8 +280,8 @@ const xcb_query_extension_reply_t *xcb_get_extension_data(xcb_connection_t *c, x
  *
  * This function allows a "prefetch" of extension data into the
  * extension cache. Invoking the function may cause a call to
- * xcb_query_extension_t, but will not block waiting for the
- * reply. xcb_get_extension_data_t will return the prefetched data after
+ * xcb_query_extension, but will not block waiting for the
+ * reply. xcb_get_extension_data will return the prefetched data after
  * possibly blocking while it is retrieved.
  */
 void xcb_prefetch_extension_data(xcb_connection_t *c, xcb_extension_t *ext);
@@ -329,7 +315,7 @@ const xcb_setup_t *xcb_get_setup(xcb_connection_t *c);
  * @return The file descriptor.
  *
  * Accessor for the file descriptor that was passed to the
- * xcb_connect_to_fd_t call that returned @p c.
+ * xcb_connect_to_fd call that returned @p c.
  */
 int xcb_get_file_descriptor(xcb_connection_t *c);
 
@@ -356,10 +342,9 @@ int xcb_connection_has_error(xcb_connection_t *c);
  *
  * Connects to an X server, given the open socket @p fd and the
  * xcb_auth_info_t @p auth_info. The file descriptor @p fd is
- * bidirectionally connected to an X server. xcb_get_tcpfd_t and
- * xcb_get_unix_fd_t return appropriate file descriptors. If the connection
+ * bidirectionally connected to an X server. If the connection
  * should be unauthenticated, @p auth_info must be @c
- * NULL. xcb_get_auth_info_t returns appropriate authentication data.
+ * NULL.
  */
 xcb_connection_t *xcb_connect_to_fd(int fd, xcb_auth_info_t *auth_info);