[Xcb-commit] 3 commits - Doxyfile event icccm NEWS property reply xcb_util_intro.in
Julien Danjou
jdanjou at kemper.freedesktop.org
Tue Sep 16 08:12:19 PDT 2008
Doxyfile | 6
NEWS | 14 --
event/xcb_event.h | 12 +
icccm/xcb_icccm.h | 320 ++++++++++++++++++++++++------------------------
property/xcb_property.h | 12 +
reply/xcb_reply.h | 13 +
xcb_util_intro.in | 13 +
7 files changed, 216 insertions(+), 174 deletions(-)
New commits:
commit 044d75cb52066c2808b0cde53fbf7fb695849ce5
Author: Julien Danjou <julien at danjou.info>
Date: Tue Sep 16 17:11:40 2008 +0200
doc: enable doxygen doc in various submodule
Signed-off-by: Julien Danjou <julien at danjou.info>
diff --git a/Doxyfile b/Doxyfile
index 937be7a..ffb0602 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -484,7 +484,11 @@ WARN_LOGFILE =
# with spaces.
INPUT = xcb_util_intro \
- image/
+ event/ \
+ icccm/ \
+ image/ \
+ property/ \
+ reply/
# This tag can be used to specify the character encoding of the source files that
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
diff --git a/event/xcb_event.h b/event/xcb_event.h
index 2e57bd6..8750dee 100644
--- a/event/xcb_event.h
+++ b/event/xcb_event.h
@@ -26,6 +26,14 @@
* prior written authorization from the authors.
*/
+/**
+ * @defgroup xcb__event_t XCB Event Functions
+ *
+ * These functions ease the handling of X events received.
+ *
+ * @{
+ */
+
#ifndef __XCB_EVENT_H__
#define __XCB_EVENT_H__
@@ -155,4 +163,8 @@ XCB_EVENT_MAKE_EVENT_HANDLER(mapping_notify, MAPPING_NOTIFY)
}
#endif
+/**
+ * @}
+ */
+
#endif /* __XCB_EVENT_H__ */
diff --git a/icccm/xcb_icccm.h b/icccm/xcb_icccm.h
index 566fe48..3adf259 100644
--- a/icccm/xcb_icccm.h
+++ b/icccm/xcb_icccm.h
@@ -30,6 +30,15 @@
* prior written authorization from the authors.
*/
+/**
+ * @defgroup xcb__icccm_t XCB ICCCM Functions
+ *
+ * These functions allow easy handling of the protocol described in the
+ * Inter-Client Communication Conventions Manual.
+ *
+ * @{
+ */
+
#include <xcb/xcb.h>
#include "xcb_property.h"
@@ -56,9 +65,9 @@ typedef struct {
/**
* @brief Deliver a GetProperty request to the X server.
- * @param c: The connection to the X server.
- * @param window: Window X identifier.
- * @param property: Property atom to get.
+ * @param c The connection to the X server.
+ * @param window Window X identifier.
+ * @param property Property atom to get.
* @return The request cookie.
*
* Allow to get a window property, in most case you might want to use
@@ -77,10 +86,10 @@ xcb_get_property_cookie_t xcb_get_text_property_unchecked(xcb_connection_t *c,
/**
* @brief Fill given structure with the property value of a window.
- * @param c: The connection to the X server.
- * @param cookie: TextProperty request cookie.
- * @param prop: TextProperty reply which is to be filled.
- * @param e: Error if any.
+ * @param c The connection to the X server.
+ * @param cookie TextProperty request cookie.
+ * @param prop TextProperty reply which is to be filled.
+ * @param e Error if any.
* @return Return 1 on success, 0 otherwise.
*
* The parameter e supplied to this function must be NULL if
@@ -96,7 +105,7 @@ uint8_t xcb_get_text_property_reply(xcb_connection_t *c,
/**
* @brief Wipe prop structure members previously allocated by
* xcb_get_text_property_reply().
- * @param prop: prop structure whose members is going to be freed.
+ * @param prop prop structure whose members is going to be freed.
*/
void xcb_get_text_property_reply_wipe(xcb_get_text_property_reply_t *prop);
@@ -104,11 +113,11 @@ void xcb_get_text_property_reply_wipe(xcb_get_text_property_reply_t *prop);
/**
* @brief Deliver a SetProperty request to set WM_NAME property value.
- * @param c: The connection to the X server.
- * @param window: Window X identifier.
- * @param encoding: Encoding used.
- * @param name_len: Length of name value to set.
- * @param name: Name value to set.
+ * @param c The connection to the X server.
+ * @param window Window X identifier.
+ * @param encoding Encoding used.
+ * @param name_len Length of name value to set.
+ * @param name Name value to set.
*/
void xcb_set_wm_name_checked(xcb_connection_t *c,
xcb_window_t window,
@@ -125,8 +134,8 @@ void xcb_set_wm_name(xcb_connection_t *c, xcb_window_t window,
/**
* @brief Deliver a GetProperty request to the X server for WM_NAME.
- * @param c: The connection to the X server.
- * @param window: Window X identifier.
+ * @param c The connection to the X server.
+ * @param window Window X identifier.
* @return The request cookie.
*/
xcb_get_property_cookie_t xcb_get_wm_name(xcb_connection_t *c,
@@ -140,10 +149,10 @@ xcb_get_property_cookie_t xcb_get_wm_name_unchecked(xcb_connection_t *c,
/**
* @brief Fill given structure with the WM_NAME property of a window.
- * @param c: The connection to the X server.
- * @param cookie: Request cookie.
- * @param prop: WM_NAME property value.
- * @param e: Error if any.
+ * @param c The connection to the X server.
+ * @param cookie Request cookie.
+ * @param prop WM_NAME property value.
+ * @param e Error if any.
* @see xcb_get_text_property_reply()
* @return Return 1 on success, 0 otherwise.
*/
@@ -154,10 +163,10 @@ uint8_t xcb_get_wm_name_reply(xcb_connection_t *c,
/**
* @brief Set a callback on WM_NAME property changes.
- * @param prophs: Property handlers.
- * @param long_len: Length of data.
- * @param handler: The callback.
- * @param data: data given to the callback.
+ * @param prophs Property handlers.
+ * @param long_len Length of data.
+ * @param handler The callback.
+ * @param data data given to the callback.
*/
void xcb_watch_wm_name(xcb_property_handlers_t *prophs, uint32_t long_len,
xcb_generic_property_handler_t handler, void *data);
@@ -166,11 +175,11 @@ void xcb_watch_wm_name(xcb_property_handlers_t *prophs, uint32_t long_len,
/**
* @brief Deliver a SetProperty request to set WM_ICON_NAME property value.
- * @param c: The connection to the X server.
- * @param window: Window X identifier.
- * @param encoding: Encoding used.
- * @param name_len: Length of name value to set.
- * @param name: Name value to set.
+ * @param c The connection to the X server.
+ * @param window Window X identifier.
+ * @param encoding Encoding used.
+ * @param name_len Length of name value to set.
+ * @param name Name value to set.
*/
void xcb_set_wm_icon_name_checked(xcb_connection_t *c, xcb_window_t window,
xcb_atom_t encoding, uint32_t name_len,
@@ -185,8 +194,8 @@ void xcb_set_wm_icon_name(xcb_connection_t *c, xcb_window_t window,
/**
* @brief Send request to get WM_ICON_NAME property of a window.
- * @param c: The connection to the X server.
- * @param window: Window X identifier.
+ * @param c The connection to the X server.
+ * @param window Window X identifier.
* @return The request cookie.
*/
xcb_get_property_cookie_t xcb_get_wm_icon_name(xcb_connection_t *c,
@@ -200,10 +209,10 @@ xcb_get_property_cookie_t xcb_get_wm_icon_name_unchecked(xcb_connection_t *c,
/**
* @brief Fill given structure with the WM_ICON_NAME property of a window.
- * @param c: The connection to the X server.
- * @param cookie: Request cookie.
- * @param prop: WM_ICON_NAME property value.
- * @param e: Error if any.
+ * @param c The connection to the X server.
+ * @param cookie Request cookie.
+ * @param prop WM_ICON_NAME property value.
+ * @param e Error if any.
* @see xcb_get_text_property_reply()
* @return Return 1 on success, 0 otherwise.
*/
@@ -214,10 +223,10 @@ uint8_t xcb_get_wm_icon_name_reply(xcb_connection_t *c,
/**
* @brief Set a callback on WM_ICON_NAME property changes.
- * @param prophs: Property handlers.
- * @param long_len: Length of data.
- * @param handler: The callback.
- * @param data: data given to the callback.
+ * @param prophs Property handlers.
+ * @param long_len Length of data.
+ * @param handler The callback.
+ * @param data data given to the callback.
*/
void xcb_watch_wm_icon_name(xcb_property_handlers_t *prophs, uint32_t long_len,
xcb_generic_property_handler_t handler,
@@ -227,11 +236,11 @@ void xcb_watch_wm_icon_name(xcb_property_handlers_t *prophs, uint32_t long_len,
/**
* @brief Deliver a SetProperty request to set WM_CLIENT_MACHINE property value.
- * @param c: The connection to the X server.
- * @param window: Window X identifier.
- * @param encoding: Encoding used.
- * @param name_len: Length of name value to set.
- * @param name: Name value to set.
+ * @param c The connection to the X server.
+ * @param window Window X identifier.
+ * @param encoding Encoding used.
+ * @param name_len Length of name value to set.
+ * @param name Name value to set.
*/
void xcb_set_wm_client_machine_checked(xcb_connection_t *c, xcb_window_t window,
xcb_atom_t encoding, uint32_t name_len,
@@ -246,8 +255,8 @@ void xcb_set_wm_client_machine(xcb_connection_t *c, xcb_window_t window,
/**
* @brief Send request to get WM_CLIENT_MACHINE property of a window.
- * @param c: The connection to the X server.
- * @param window: Window X identifier.
+ * @param c The connection to the X server.
+ * @param window Window X identifier.
* @return The request cookie.
*/
xcb_get_property_cookie_t xcb_get_wm_client_machine(xcb_connection_t *c,
@@ -261,10 +270,10 @@ xcb_get_property_cookie_t xcb_get_wm_client_machine_unchecked(xcb_connection_t *
/**
* @brief Fill given structure with the WM_CLIENT_MACHINE property of a window.
- * @param c: The connection to the X server.
- * @param cookie: Request cookie.
- * @param prop: WM_CLIENT_MACHINE property value.
- * @param e: Error if any.
+ * @param c The connection to the X server.
+ * @param cookie Request cookie.
+ * @param prop WM_CLIENT_MACHINE property value.
+ * @param e Error if any.
* @see xcb_get_text_property_reply()
* @return Return 1 on success, 0 otherwise.
*/
@@ -275,10 +284,10 @@ uint8_t xcb_get_wm_client_machine_reply(xcb_connection_t *c,
/**
* @brief Set a callback on WM_CLIENT_MACHINE property changes.
- * @param prophs: Property handlers.
- * @param long_len: Length of data.
- * @param handler: The callback.
- * @param data: data given to the callback.
+ * @param prophs Property handlers.
+ * @param long_len Length of data.
+ * @param handler The callback.
+ * @param data data given to the callback.
*/
void xcb_watch_wm_client_machine(xcb_property_handlers_t *prophs,
uint32_t long_len,
@@ -302,8 +311,8 @@ typedef struct {
/**
* @brief Deliver a GetProperty request to the X server for WM_CLASS.
- * @param c: The connection to the X server.
- * @param window: Window X identifier.
+ * @param c The connection to the X server.
+ * @param window Window X identifier.
* @return The request cookie.
*/
xcb_get_property_cookie_t xcb_get_wm_class(xcb_connection_t *c,
@@ -317,10 +326,10 @@ xcb_get_property_cookie_t xcb_get_wm_class_unchecked(xcb_connection_t *c,
/**
* @brief Fill given structure with the WM_CLASS property of a window.
- * @param c: The connection to the X server.
- * @param cookie: Request cookie.
- * @param prop: WM_CLASS property value.
- * @param e: Error if any.
+ * @param c The connection to the X server.
+ * @param cookie Request cookie.
+ * @param prop WM_CLASS property value.
+ * @param e Error if any.
* @return Return 1 on success, 0 otherwise.
*
* The parameter e supplied to this function must be NULL if
@@ -336,7 +345,7 @@ uint8_t xcb_get_wm_class_reply(xcb_connection_t *c,
/**
* @brief Wipe prop structure members previously allocated by
* xcb_get_wm_class_reply().
- * @param prop: prop structure whose members is going to be freed.
+ * @param prop prop structure whose members is going to be freed.
*/
void xcb_get_wm_class_reply_wipe(xcb_get_wm_class_reply_t *prop);
@@ -344,8 +353,8 @@ void xcb_get_wm_class_reply_wipe(xcb_get_wm_class_reply_t *prop);
/**
* @brief Send request to get WM_TRANSIENT_FOR property of a window.
- * @param c: The connection to the X server
- * @param window: Window X identifier.
+ * @param c The connection to the X server
+ * @param window Window X identifier.
* @return The request cookie.
*/
xcb_get_property_cookie_t xcb_get_wm_transient_for(xcb_connection_t *c,
@@ -359,10 +368,10 @@ xcb_get_property_cookie_t xcb_get_wm_transient_for_unchecked(xcb_connection_t *c
/**
* @brief Fill given structure with the WM_TRANSIENT_FOR property of a window.
- * @param c: The connection to the X server.
- * @param cookie: Request cookie.
- * @param prop: WM_TRANSIENT_FOR property value.
- * @param e: Error if any.
+ * @param c The connection to the X server.
+ * @param cookie Request cookie.
+ * @param prop WM_TRANSIENT_FOR property value.
+ * @param e Error if any.
* @return Return 1 on success, 0 otherwise.
*
* The parameter e supplied to this function must be NULL if
@@ -417,58 +426,58 @@ typedef struct {
/**
* @brief Set size hints to a given position.
- * @param hints: SIZE_HINTS structure.
- * @param user_specified: Is the size user-specified?
- * @param x: The X position.
- * @param y: The Y position.
+ * @param hints SIZE_HINTS structure.
+ * @param user_specified Is the size user-specified?
+ * @param x The X position.
+ * @param y The Y position.
*/
void xcb_size_hints_set_position(xcb_size_hints_t *hints, int user_specified,
int32_t x, int32_t y);
/**
* @brief Set size hints to a given size.
- * @param hints: SIZE_HINTS structure.
- * @param user_specified: is the size user-specified?
- * @param width: The width.
- * @param height: The height.
+ * @param hints SIZE_HINTS structure.
+ * @param user_specified is the size user-specified?
+ * @param width The width.
+ * @param height The height.
*/
void xcb_size_hints_set_size(xcb_size_hints_t *hints, int user_specified,
int32_t width, int32_t height);
/**
* @brief Set size hints to a given minimum size.
- * @param hints: SIZE_HINTS structure.
- * @param width: The minimum width.
- * @param height: The minimum height.
+ * @param hints SIZE_HINTS structure.
+ * @param width The minimum width.
+ * @param height The minimum height.
*/
void xcb_size_hints_set_min_size(xcb_size_hints_t *hints, int32_t min_width,
int32_t min_height);
/**
* @brief Set size hints to a given maximum size.
- * @param hints: SIZE_HINTS structure.
- * @param width: The maximum width.
- * @param height: The maximum height.
+ * @param hints SIZE_HINTS structure.
+ * @param width The maximum width.
+ * @param height The maximum height.
*/
void xcb_size_hints_set_max_size(xcb_size_hints_t *hints, int32_t max_width,
int32_t max_height);
/**
* @brief Set size hints to a given resize increments.
- * @param hints: SIZE_HINTS structure.
- * @param width: The resize increments width.
- * @param height: The resize increments height.
+ * @param hints SIZE_HINTS structure.
+ * @param width The resize increments width.
+ * @param height The resize increments height.
*/
void xcb_size_hints_set_resize_inc(xcb_size_hints_t *hints, int32_t width_inc,
int32_t height_inc);
/**
* @brief Set size hints to a given aspect ratios.
- * @param hints: SIZE_HINTS structure.
- * @param min_aspect_num: The minimum aspect ratios for the width.
- * @param min_aspect_den: The minimum aspect ratios for the height.
- * @param max_aspect_num: The maximum aspect ratios for the width.
- * @param max_aspect_den: The maximum aspect ratios for the height.
+ * @param hints SIZE_HINTS structure.
+ * @param min_aspect_num The minimum aspect ratios for the width.
+ * @param min_aspect_den The minimum aspect ratios for the height.
+ * @param max_aspect_num The maximum aspect ratios for the width.
+ * @param max_aspect_den The maximum aspect ratios for the height.
*/
void xcb_size_hints_set_aspect(xcb_size_hints_t *hints, int32_t min_aspect_num,
int32_t min_aspect_den, int32_t max_aspect_num,
@@ -476,27 +485,27 @@ void xcb_size_hints_set_aspect(xcb_size_hints_t *hints, int32_t min_aspect_num,
/**
* @brief Set size hints to a given base size.
- * @param hints: SIZE_HINTS structure.
- * @param base_width: Base width.
- * @param base_height: Base height.
+ * @param hints SIZE_HINTS structure.
+ * @param base_width Base width.
+ * @param base_height Base height.
*/
void xcb_size_hints_set_base_size(xcb_size_hints_t *hints, int32_t base_width,
int32_t base_height);
/**
* @brief Set size hints to a given window gravity.
- * @param hints: SIZE_HINTS structure.
- * @param win_gravity: Window gravity value.
+ * @param hints SIZE_HINTS structure.
+ * @param win_gravity Window gravity value.
*/
void xcb_size_hints_set_win_gravity(xcb_size_hints_t *hints,
uint8_t win_gravity);
/**
* @brief Deliver a ChangeProperty request to set a value to a given property.
- * @param c: The connection to the X server.
- * @param window: Window X identifier.
- * @param property: Property to set value for.
- * @param hints: Hints value to set.
+ * @param c The connection to the X server.
+ * @param window Window X identifier.
+ * @param property Property to set value for.
+ * @param hints Hints value to set.
*/
void xcb_set_wm_size_hints_checked(xcb_connection_t *c, xcb_window_t window,
xcb_atom_t property, xcb_size_hints_t *hints);
@@ -509,9 +518,9 @@ void xcb_set_wm_size_hints(xcb_connection_t *c, xcb_window_t window,
/**
* @brief Send request to get size hints structure for the named property.
- * @param c: The connection to the X server.
- * @param window: Window X identifier.
- * @param property: Specify the property name.
+ * @param c The connection to the X server.
+ * @param window Window X identifier.
+ * @param property Specify the property name.
* @return The request cookie.
*/
xcb_get_property_cookie_t xcb_get_wm_size_hints(xcb_connection_t *c,
@@ -527,10 +536,10 @@ xcb_get_property_cookie_t xcb_get_wm_size_hints_unchecked(xcb_connection_t *c,
/**
* @brief Fill given structure with the size hints of the named property.
- * @param c: The connection to the X server.
- * @param cookie: Request cookie.
- * @param hints: Size hints structure.
- * @param e: Error if any.
+ * @param c The connection to the X server.
+ * @param cookie Request cookie.
+ * @param hints Size hints structure.
+ * @param e Error if any.
* @return Return 1 on success, 0 otherwise.
*
* The parameter e supplied to this function must be NULL if
@@ -546,9 +555,9 @@ uint8_t xcb_get_wm_size_hints_reply(xcb_connection_t *c,
/**
* @brief Deliver a ChangeProperty request to set WM_NORMAL_HINTS property value.
- * @param c: The connection to the X server.
- * @param window: Window X identifier.
- * @param hints: Hints value to set.
+ * @param c The connection to the X server.
+ * @param window Window X identifier.
+ * @param hints Hints value to set.
*/
void xcb_set_wm_normal_hints_checked(xcb_connection_t *c, xcb_window_t window,
xcb_size_hints_t *hints);
@@ -561,8 +570,8 @@ void xcb_set_wm_normal_hints(xcb_connection_t *c, xcb_window_t window,
/**
* @brief Send request to get WM_NORMAL_HINTS property of a window.
- * @param c: The connection to the X server.
- * @param window: Window X identifier.
+ * @param c The connection to the X server.
+ * @param window Window X identifier.
* @return The request cookie.
*/
xcb_get_property_cookie_t xcb_get_wm_normal_hints(xcb_connection_t *c,
@@ -576,8 +585,8 @@ xcb_get_property_cookie_t xcb_get_wm_normal_hints_unchecked(xcb_connection_t *c,
/**
* @brief Fill given structure with the WM_NORMAL_HINTS property of a window.
- * @param hints: WM_NORMAL_HINTS property value.
- * @param reply: The get property request reply.
+ * @param hints WM_NORMAL_HINTS property value.
+ * @param reply The get property request reply.
* @return Return 1 on success, 0 otherwise.
*/
uint8_t
@@ -586,10 +595,10 @@ xcb_get_wm_size_hints_from_reply(xcb_size_hints_t *hints,
/**
* @brief Fill given structure with the WM_NORMAL_HINTS property of a window.
- * @param c: The connection to the X server.
- * @param cookie: Request cookie.
- * @param hints: WM_NORMAL_HINTS property value.
- * @param e: Error if any.
+ * @param c The connection to the X server.
+ * @param cookie Request cookie.
+ * @param hints WM_NORMAL_HINTS property value.
+ * @param e Error if any.
* @return Return 1 on success, 0 otherwise.
*
* The parameter e supplied to this function must be NULL if
@@ -656,84 +665,84 @@ typedef enum {
/**
* @brief Get urgency hint.
- * @param hints: WM_HINTS structure.
+ * @param hints WM_HINTS structure.
* @return Urgency hint value.
*/
uint32_t xcb_wm_hints_get_urgency(xcb_wm_hints_t *hints);
/**
* @brief Set input focus.
- * @param hints: WM_HINTS structure.
- * @param input: Input focus.
+ * @param hints WM_HINTS structure.
+ * @param input Input focus.
*/
void xcb_wm_hints_set_input(xcb_wm_hints_t *hints, uint8_t input);
/**
* @brief Set hints state to 'iconic'.
- * @param hints: WM_HINTS structure.
+ * @param hints WM_HINTS structure.
*/
void xcb_wm_hints_set_iconic(xcb_wm_hints_t *hints);
/**
* @brief Set hints state to 'normal'.
- * @param hints: WM_HINTS structure.
+ * @param hints WM_HINTS structure.
*/
void xcb_wm_hints_set_normal(xcb_wm_hints_t *hints);
/**
* @brief Set hints state to 'withdrawn'.
- * @param hints: WM_HINTS structure.
+ * @param hints WM_HINTS structure.
*/
void xcb_wm_hints_set_withdrawn(xcb_wm_hints_t *hints);
/**
* @brief Set hints state to none.
- * @param hints: WM_HINTS structure.
+ * @param hints WM_HINTS structure.
*/
void xcb_wm_hints_set_none(xcb_wm_hints_t *hints);
/**
* @brief Set pixmap to be used as icon.
- * @param hints: WM_HINTS structure.
- * @param icon_pixmap: Pixmap.
+ * @param hints WM_HINTS structure.
+ * @param icon_pixmap Pixmap.
*/
void xcb_wm_hints_set_icon_pixmap(xcb_wm_hints_t *hints,
xcb_pixmap_t icon_pixmap);
/**
* @brief Set icon mask bitmap.
- * @param hints: WM_HINTS structure.
- * @param icon_mask: Pixmap.
+ * @param hints WM_HINTS structure.
+ * @param icon_mask Pixmap.
*/
void xcb_wm_hints_set_icon_mask(xcb_wm_hints_t *hints, xcb_pixmap_t icon_mask);
/**
* @brief Set window identifier to be used as icon.
- * @param hints: WM_HINTS structure.
- * @param icon_window: Window X identifier.
+ * @param hints WM_HINTS structure.
+ * @param icon_window Window X identifier.
*/
void xcb_wm_hints_set_icon_window(xcb_wm_hints_t *hints,
xcb_window_t icon_window);
/**
* @brief Set identifier of related window group.
- * @param hints: WM_HINTS structure.
- * @param window_group: Window X identifier.
+ * @param hints WM_HINTS structure.
+ * @param window_group Window X identifier.
*/
void xcb_wm_hints_set_window_group(xcb_wm_hints_t *hints,
xcb_window_t window_group);
/**
* @brief Set urgency hints flag.
- * @param hints: WM_HINTS structure.
+ * @param hints WM_HINTS structure.
*/
void xcb_wm_hints_set_urgency(xcb_wm_hints_t *hints);
/**
* @brief Deliver a SetProperty request to set WM_HINTS property value.
- * @param c: The connection to the X server.
- * @param window: Window X identifier.
- * @param hints: Hints value to set.
+ * @param c The connection to the X server.
+ * @param window Window X identifier.
+ * @param hints Hints value to set.
*/
void xcb_set_wm_hints_checked(xcb_connection_t *c, xcb_window_t window,
xcb_wm_hints_t *hints);
@@ -746,8 +755,8 @@ void xcb_set_wm_hints(xcb_connection_t *c, xcb_window_t window,
/**
* @brief Send request to get WM_HINTS property of a window.
- * @param c: The connection to the X server.
- * @param window: Window X identifier.
+ * @param c The connection to the X server.
+ * @param window Window X identifier.
* @return The request cookie.
*/
xcb_get_property_cookie_t xcb_get_wm_hints(xcb_connection_t *c,
@@ -761,8 +770,8 @@ xcb_get_property_cookie_t xcb_get_wm_hints_unchecked(xcb_connection_t *c,
/**
* @brief Fill given structure with the WM_HINTS property of a window.
- * @param hints: WM_HINTS property value.
- * @param reply: The get property request reply.
+ * @param hints WM_HINTS property value.
+ * @param reply The get property request reply.
* @return Return 1 on success, 0 otherwise.
*/
uint8_t
@@ -771,10 +780,10 @@ xcb_get_wm_hints_from_reply(xcb_wm_hints_t *hints,
/**
* @brief Fill given structure with the WM_HINTS property of a window.
- * @param c: The connection to the X server.
- * @param cookie: Request cookie.
- * @param hints: WM_HINTS property value.
- * @param e: Error if any.
+ * @param c The connection to the X server.
+ * @param cookie Request cookie.
+ * @param hints WM_HINTS property value.
+ * @param e Error if any.
* @return Return 1 on success, 0 otherwise.
*
* The parameter e supplied to this function must be NULL if
@@ -790,11 +799,11 @@ uint8_t xcb_get_wm_hints_reply(xcb_connection_t *c,
/**
* @brief Deliver a SetProperty request to set WM_PROTOCOLS property value.
- * @param c: The connection to the X server.
- * @param wm_protocols: The WM_PROTOCOLS atom.
- * @param window: Window X identifier.
- * @param list_len: Atom list len.
- * @param list: Atom list.
+ * @param c The connection to the X server.
+ * @param wm_protocols The WM_PROTOCOLS atom.
+ * @param window Window X identifier.
+ * @param list_len Atom list len.
+ * @param list Atom list.
*/
void xcb_set_wm_protocols_checked(xcb_connection_t *c, xcb_atom_t wm_protocols,
xcb_window_t window, uint32_t list_len,
@@ -822,8 +831,8 @@ typedef struct {
/**
* @brief Send request to get WM_PROTOCOLS property of a given window.
- * @param c: The connection to the X server.
- * @param window: Window X identifier.
+ * @param c The connection to the X server.
+ * @param window Window X identifier.
* @return The request cookie.
*/
xcb_get_property_cookie_t xcb_get_wm_protocols(xcb_connection_t *c,
@@ -839,10 +848,10 @@ xcb_get_property_cookie_t xcb_get_wm_protocols_unchecked(xcb_connection_t *c,
/**
* @brief Fill the given structure with the WM_PROTOCOLS property of a window.
- * @param c: The connection to the X server.
- * @param cookie: Request cookie.
- * @param protocols: WM_PROTOCOLS property value.
- * @param e: Error if any.
+ * @param c The connection to the X server.
+ * @param cookie Request cookie.
+ * @param protocols WM_PROTOCOLS property value.
+ * @param e Error if any.
* @return Return 1 on success, 0 otherwise.
*
* The parameter e supplied to this function must be NULL if
@@ -858,7 +867,7 @@ uint8_t xcb_get_wm_protocols_reply(xcb_connection_t *c,
/**
* @brief Wipe protocols structure members previously allocated by
* xcb_get_wm_protocols_reply().
- * @param protocols: protocols structure whose members is going to be freed.
+ * @param protocols protocols structure whose members is going to be freed.
*/
void xcb_get_wm_protocols_reply_wipe(xcb_get_wm_protocols_reply_t *protocols);
@@ -866,5 +875,8 @@ void xcb_get_wm_protocols_reply_wipe(xcb_get_wm_protocols_reply_t *protocols);
}
#endif
+/**
+ * @}
+ */
#endif /* __XCB_ICCCM_H__ */
diff --git a/property/xcb_property.h b/property/xcb_property.h
index ea2962c..1137ab0 100644
--- a/property/xcb_property.h
+++ b/property/xcb_property.h
@@ -26,6 +26,14 @@
* prior written authorization from the authors.
*/
+/**
+ * @defgroup xcb__property_t XCB Property Functions
+ *
+ * These functions ease the handling of X propertiess received.
+ *
+ * @{
+ */
+
#ifndef __XCB_PROPERTY_H__
#define __XCB_PROPERTY_H__
@@ -146,4 +154,8 @@ int xcb_property_changed(xcb_property_handlers_t *prophs, uint8_t state, xcb_win
}
#endif
+/**
+ * @}
+ */
+
#endif /* __XCB_PROPERTY_H__ */
diff --git a/reply/xcb_reply.h b/reply/xcb_reply.h
index 360f74a..71d07ac 100644
--- a/reply/xcb_reply.h
+++ b/reply/xcb_reply.h
@@ -26,6 +26,15 @@
* prior written authorization from the authors.
*/
+/**
+ * @defgroup xcb__reply_t XCB Reply Functions
+ *
+ * These functions ease the usage of asynchronous possibility of XCB about
+ * the reply retrieve of sent requests.
+ *
+ * @{
+ */
+
#ifndef __XCB_REPLY_H__
#define __XCB_REPLY_H__
@@ -106,4 +115,8 @@ void xcb_reply_add_handler(xcb_reply_handlers_t *h, unsigned int request, xcb_ge
}
#endif
+/**
+ * @}
+ */
+
#endif /* __XCB_REPLY_H__ */
commit 7cf4451073fe04dd177c40e19b8b5b18846d345e
Author: Julien Danjou <julien at danjou.info>
Date: Tue Sep 16 17:11:14 2008 +0200
doc: add various authors, remove old todo item
Signed-off-by: Julien Danjou <julien at danjou.info>
diff --git a/xcb_util_intro.in b/xcb_util_intro.in
index 482d658..f063613 100644
--- a/xcb_util_intro.in
+++ b/xcb_util_intro.in
@@ -2,20 +2,23 @@
@file
@brief XCB Utility functions
-These routines are used to facilitate the use of XCB in programs
+These routines are used to facilitate the use of XCB in programs.
*/
/**
@mainpage XCB Utility Documentation
@version @PACKAGE_VERSION@
+ at author Ian Osgood <iano at quirkster.com>
+ at author Bart Massey <bart at cs.pdx.edu>
@author Jamey Sharp <jamey at minilop.net>
+ at author Josh Triplett <josh at freedesktop.org>
+ at author Keith Packard <keithp at keithp.com>
@author Vincent Torri <torri at iecn.u-nancy.fr>
- at date 2005
-
+ at author Julien Danjou <julien at danjou.info>
+ at author Arnaud Fontaine <arnau at debian.org>
+ at date 2005-2008
@section intro What is available ?
- at todo Add more functions in XCBAux
-
*/
commit caa3052a13aec6ad195624d4fe16e53ad77fbb22
Author: Julien Danjou <julien at danjou.info>
Date: Tue Sep 16 16:54:20 2008 +0200
Remove NEWS
Not updated and git log is much useful.
Signed-off-by: Julien Danjou <julien at danjou.info>
diff --git a/NEWS b/NEWS
deleted file mode 100644
index 210e147..0000000
--- a/NEWS
+++ /dev/null
@@ -1,14 +0,0 @@
-version 0.2 (2006-03-02)
-=========================
-* adapt to the libxcb 1.0 Great Renaming, and try to obey the same conventions
-
-* render-util library: standard visuals and usable glyph support
-
-* xcb_aux_sync: provides same function as XSync
-
-* icccm library: make the wm_hints interface usable
-
-* libraries renamed libxcb-*; headers moved to xcb/xcb_*.h
-
-* Various build system fixes
-
More information about the xcb-commit
mailing list