summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHenning Sten <henning.sten@yahoo.com>2008-09-16 20:28:13 +0200
committerJulien Danjou <julien@danjou.info>2008-09-17 11:04:50 +0200
commit28cd98c0a6e92e257613729fd2ac8c4630077edb (patch)
tree2fd907ebfb7c6ef963d822ea0fa9a8d35642fcec
parent8efc9b87d1f3e13ed3e198b55ed355a508e0c130 (diff)
add doxygen documentation markup for XCB_EVENT_RESPONSE_TYPE_MASK macro0.3.0
Signed-off-by: Julien Danjou <julien@danjou.info>
-rw-r--r--event/xcb_event.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/event/xcb_event.h b/event/xcb_event.h
index 8750dee..c2d1cd6 100644
--- a/event/xcb_event.h
+++ b/event/xcb_event.h
@@ -43,6 +43,15 @@
extern "C" {
#endif
+/**
+ * @brief Bit mask to find event type regardless of event source.
+ *
+ * Each event in the X11 protocol contains an 8-bit type code.
+ * The most-significant bit in this code is set if the event was
+ * generated from a SendEvent request. This mask can be used to
+ * determine the type of event regardless of how the event was
+ * generated. See the X11R6 protocol specification for details.
+ */
#define XCB_EVENT_RESPONSE_TYPE_MASK (0x7f)
#define XCB_EVENT_RESPONSE_TYPE(e) (e->response_type & XCB_EVENT_RESPONSE_TYPE_MASK)
#define XCB_EVENT_SENT(e) (e->response_type & ~XCB_EVENT_RESPONSE_TYPE_MASK)