diff options
author | marha <marha@users.sourceforge.net> | 2012-03-27 17:04:46 +0200 |
---|---|---|
committer | marha <marha@users.sourceforge.net> | 2012-03-27 17:04:46 +0200 |
commit | ec617f09d07e32d6f57c0da133f53ad3d43a568a (patch) | |
tree | 336f2ef770cf4bd48005f99fcbac22ec64ff51db /libxcb/xcb-proto/doc | |
parent | 1d6d472342aee7b9c68e9f1d92762ef808d35ac2 (diff) | |
download | vcxsrv-ec617f09d07e32d6f57c0da133f53ad3d43a568a.tar.gz vcxsrv-ec617f09d07e32d6f57c0da133f53ad3d43a568a.tar.bz2 vcxsrv-ec617f09d07e32d6f57c0da133f53ad3d43a568a.zip |
fontconfig libxcb xcb-proto mesa xserver git update 27 Mar 2012
Diffstat (limited to 'libxcb/xcb-proto/doc')
-rw-r--r-- | libxcb/xcb-proto/doc/xml-xcb.txt | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/libxcb/xcb-proto/doc/xml-xcb.txt b/libxcb/xcb-proto/doc/xml-xcb.txt index 3c6a15519..705772736 100644 --- a/libxcb/xcb-proto/doc/xml-xcb.txt +++ b/libxcb/xcb-proto/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. |