fix doxy doc

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

diff --git a/src/xcb.h b/src/xcb.h
index 15c5768..4c3e079 100644 (file)
--- a/src/xcb.h
+++ b/src/xcb.h
@@ -112,7 +112,7 @@ typedef struct {
     uint8_t  pad0;           /**< Padding */
     uint16_t sequence;       /**< Sequence number */
     uint32_t pad[7];         /**< Padding */
-    uint32_t full_sequence;
+    uint32_t full_sequence;  /**< full sequence */
 } xcb_generic_event_t;
 
 /**
@@ -125,7 +125,7 @@ typedef struct {
     uint8_t   error_code;     /**< Error code */
     uint16_t sequence;       /**< Sequence number */
     uint32_t pad[7];         /**< Padding */
-    uint32_t full_sequence;
+    uint32_t full_sequence;  /**< full sequence */
 } xcb_generic_error_t;
 
 /**
@@ -217,19 +217,16 @@ xcb_generic_event_t *xcb_wait_for_event(xcb_connection_t *c);
 /**
  * @brief Returns the next event or error from the server.
  * @param c: The connection to the X server.
- * @param error: A pointer to an int to be filled in with the I/O
  * error status of the operation.
  * @return The next event from the server.
  *
  * 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.
@@ -364,10 +361,10 @@ void xcb_disconnect(xcb_connection_t *c);
 
 /**
  * @brief Parses a display string name in the form documented by X(7x).
- * @param displayname: The name of the display.
- * @param hostp: A pointer to a malloc'd copy of the hostname.
- * @param displayp: A pointer to the display number.
- * @param screenp: A pointer to the screen number.
+ * @param name: The name of the display.
+ * @param host: A pointer to a malloc'd copy of the hostname.
+ * @param display: A pointer to the display number.
+ * @param screen: A pointer to the screen number.
  * @return 0 on failure, non 0 otherwise.
  *
  * Parses the display string name @p display_name in the form
@@ -397,9 +394,9 @@ xcb_connection_t *xcb_connect(const char *displayname, int *screenp);
 
 /**
  * @brief Connects to the X server, using an authorization information.
- * @param displayname: The name of the display.
+ * @param display: The name of the display.
  * @param auth: The authorization information.
- * @param screenp: A pointer to a preferred screen number.
+ * @param screen: A pointer to a preferred screen number.
  * @return A newly allocated xcb_connection_t structure.
  *
  * Connects to the X server specified by @p displayname, using the
@@ -410,6 +407,19 @@ xcb_connection_t *xcb_connect(const char *displayname, int *screenp);
 xcb_connection_t *xcb_connect_to_display_with_auth_info(const char *display, xcb_auth_info_t *auth, int *screen);
 
 
+/* xcb_xid.c */
+
+/**
+ * @brief Allocates an XID for a new object.
+ * @param c: The connection.
+ * @return A newly allocated XID.
+ *
+ * Allocates an XID for a new object. Typically used just prior to
+ * various object creation functions, such as xcb_create_window.
+ */
+uint32_t xcb_generate_id(xcb_connection_t *c);
+
+
 /**
  * @}
  */