diff options
author | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2014-03-15 17:24:21 +0000 |
---|---|---|
committer | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2014-03-15 17:24:21 +0000 |
commit | b3a695c053755c3d8bc163e97e20520d922f12c8 (patch) | |
tree | 44bcd6aef360a4b508a40a17d41d5e2d1d61c930 /proto/xcb-proto/doc | |
parent | 7acb26f61fb8604c5d14ca66d3f5553ad1b5f83f (diff) |
Update to xcb-proto 1.10
Diffstat (limited to 'proto/xcb-proto/doc')
-rw-r--r-- | proto/xcb-proto/doc/xml-xcb.txt | 56 |
1 files changed, 51 insertions, 5 deletions
diff --git a/proto/xcb-proto/doc/xml-xcb.txt b/proto/xcb-proto/doc/xml-xcb.txt index 3c6a15519..7311911f6 100644 --- a/proto/xcb-proto/doc/xml-xcb.txt +++ b/proto/xcb-proto/doc/xml-xcb.txt @@ -128,7 +128,8 @@ Top-Level Elements requests of the same type may be combined into a single request without affecting the semantics of the requests. -<event name="identifier" number="integer" [no-sequence-number="true"]> +<event name="identifier" number="integer" + [[no-sequence-number="true"] | [xge="true"]]> structure contents </event> @@ -142,6 +143,11 @@ Top-Level Elements include a sequence number. This is a special-case for the KeymapNotify event in the core protocol, and should not be used in any other event. + If the optional xge attribute is true, the event is an X Generic Event and + will be treated as such. + + The no-sequence-number and xge attribute can not be combined. + <error name="identifier" number="integer"> structure contents </error> @@ -229,13 +235,18 @@ enum; the value is restricted to one of the constants named in the enum. <switch> instead for new protocol definitions. <switch name="identifier"> switch expression - <bitcase> bitcase expression, fields </bitcase> </switch> + <bitcase> bitcase expression(s), fields </bitcase> </switch> This element represents conditional inclusion of fields. It can be viewed as sequence of multiple ifs: if ( switch expression & bitcase expression ) - is equal to bitcase expression, bitcase fields are included in structure. - It can be used only as the last field of structure. New protocol definitions - should prefer to use this instead of <valueparam>. + is non-zero, bitcase fields are included in structure. It can be used only + as the last field of a structure. + + When a bitcase includes multiple <enumref> clauses, the contents of the + bitcase are only present once regardless of the number of bitcase expressions + that match. + + New protocol definitions should prefer to use this instead of <valueparam>. Expressions ----------- @@ -284,3 +295,38 @@ Expressions This element represents the number of bits set in the expression. +Documentation +------------- + + Documentation for each request, reply or event is stored in the appropriate + element using a <doc> element. The <doc> element can contain the following + elements: + +<brief>brief description</brief> + + A short description of the request, reply or event. For example "makes a + window visible" for MapWindow. This will end up in the manpage NAME section + and in the doxygen @brief description. + +<description><![CDATA[longer description]]></description> + + The full description. Use `` to highlight words, such as "Draws + `points_len`-1 lines between each pair of points…" + +<example><![CDATA[example code]]</description> + + Example C code illustrating the usage of the particular request, reply or + event. + +<field name="name">field description</field> + + The full description for the specified field. Depending on the context, this + is either a request parameter or a reply/event datastructure field. + +<error type="type">error description</field> + + The full description for an error which can occur due to this request. + +<see type="request" name="name" /> + + A reference to another relevant program, function, request or event. |