summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMichael Stapelberg <michael@stapelberg.de>2011-11-27 10:35:06 +0000
committerJulien Danjou <julien@danjou.info>2012-03-26 18:23:15 +0200
commitb02b7f8dcf92f2b0e7c1edc91f48d2e388d4b8c3 (patch)
tree1fd0e70b83ae54d816d7bd0a3e08a264ba787f3b /doc
parent8c41b3c901c046756fad477e9e95de20178027c3 (diff)
xproto: add doc tags, xcbgen: handle doc tags
Signed-off-by: Julien Danjou <julien@danjou.info>
Diffstat (limited to 'doc')
-rw-r--r--doc/xml-xcb.txt35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/xml-xcb.txt b/doc/xml-xcb.txt
index 3c6a155..7057727 100644
--- a/doc/xml-xcb.txt
+++ b/doc/xml-xcb.txt
@@ -284,3 +284,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.