X-Git-Url: http://git.demorecorder.com/cgi-bin/gitweb.cgi?a=blobdiff_plain;ds=sidebyside;f=doc%2Fxml-xcb.txt;h=cf6d14e4647b814bbd7cfa70a982d7621efdab87;hb=8c85be5392b89eba6440952d1b95e3af806f1c7f;hp=3c6a155194188c6e8e88f1fd70c9000673f8852d;hpb=9d03507afa4354ce402333f94d01f6bcb2cf41e6;p=free-sw%2Fxcb%2Fproto
diff --git a/doc/xml-xcb.txt b/doc/xml-xcb.txt
index 3c6a155..cf6d14e 100644
--- a/doc/xml-xcb.txt
+++ b/doc/xml-xcb.txt
@@ -229,13 +229,18 @@ enum; the value is restricted to one of the constants named in the enum.
instead for new protocol definitions.
switch expression
- bitcase expression, fields
+ bitcase expression(s), fields
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 .
+ 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 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 .
Expressions
-----------
@@ -284,3 +289,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 element. The element can contain the following
+ elements:
+
+brief description
+
+ 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.
+
+
+
+ The full description. Use `` to highlight words, such as "Draws
+ `points_len`-1 lines between each pair of pointsâ¦"
+
+
+
+ Example C code illustrating the usage of the particular request, reply or
+ event.
+
+field description
+
+ The full description for the specified field. Depending on the context, this
+ is either a request parameter or a reply/event datastructure field.
+
+error description
+
+ The full description for an error which can occur due to this request.
+
+
+
+ A reference to another relevant program, function, request or event.