[Xcb-commit] ProtocolStubApi.mdwn

XCB site xcb at freedesktop.org
Mon Nov 12 16:57:55 PST 2007 

 ProtocolStubApi.mdwn |   30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

New commits:
commit 4ce10cab59c20aa1c5461b2862f5d6f7cf0391a5
Author: brian.thomas.will <brian.thomas.will at gmail.com>
Date:   Mon Nov 12 16:57:54 2007 -0800

    formatting cleanup (not sure about intention of links in section "types"; please check)

diff --git a/ProtocolStubApi.mdwn b/ProtocolStubApi.mdwn
index 31b9a5a..3328e0c 100644
--- a/ProtocolStubApi.mdwn
+++ b/ProtocolStubApi.mdwn
@@ -12,11 +12,11 @@ Most of the X Window Protocol documentation lives in <http://webcvs.freedesktop.
 
 ### `xcb_extension_id`
 
-`xcb_extension_t xcb_extension_id`
+		xcb_extension_t xcb_extension_id
 
 (xcb.h)
 
-A unique, opaque object identifying this extension for [xcb_get_extension_data()](#xcb_get_extension_data).
+A unique, opaque object identifying this extension for [`xcb_get_extension_data()`](#xcb_get_extension_data).
 
 ## Fields
 
@@ -32,7 +32,7 @@ The C name for the X type with name "Name" is `xcb_name_t`. If the type is from
 
 [!] _**TODO:**Links to XCBProtocolLanguage should be changed to point to appropriate [[XmlXcb]] documentation._
 
-Types are declared using the [[XCBProtocolLanguage#STRUCT|XCBProtocolLanguage]], [[XCBProtocolLanguage#UNION|XCBProtocolLanguage]], [[XCBProtocolLanguage#XIDTYPE|XCBProtocolLanguage]], [[XCBProtocolLanguage#ENUM|XCBProtocolLanguage]], and ["XCBProtocolLanguage#TYPEDEF: TYPEDEF] protocol description macros.
+Types are declared using the [[STRUCT|XmlXcb#STRUCT]], [[UNION|XmlXcb#UNION]], [[XIDTYPE|XmlXcb#XIDTYPE]], [[ENUM|XmlXcb#ENUM]], and [[TYPEDEF|XmlXcb#TYPEDEF]] protocol description macros.
 
 <a name="xcb_name_iterator_t"></a>
 
@@ -46,7 +46,7 @@ Types are declared using the [[XCBProtocolLanguage#STRUCT|XCBProtocolLanguage]],
 
 An iterator may only be created for types declared using the [[XCBProtocolLanguage#STRUCT|XCBProtocolLanguage]] and [[XCBProtocolLanguage#XIDTYPE|XCBProtocolLanguage]] protocol description macros.
 
-A special iterator type, xcb_generic_iterator_t, is declared in xcb.h.
+A special iterator type, `xcb_generic_iterator_t`, is declared in xcb.h.
 
 ### `xcb_name_next`
 
@@ -104,7 +104,7 @@ The base C name for all types and functions related to the X request with name "
 			unsigned int sequence;
 		} xcb_name_cookie_t;
 
-A special cookie type, `xcb_void_cookie_t`, is declared in xcb.h. See [xcb_name](#xcb_name).
+A special cookie type, `xcb_void_cookie_t`, is declared in xcb.h. See [`xcb_name`](#xcb_name).
 
 ### `xcb_name_request_t`
 
@@ -139,9 +139,9 @@ A special reply type, `xcb_generic_reply_t`, is declared in xcb.h. It contains o
 
 Delivers a request with the specified arguments to the X server.
 
-If the request will cause a reply to be generated, then an [xcb_name_cookie_t](#xcb_name_cookie_t) will be returned and the [xcb_name_reply_t](#xcb_name_reply_t) function should be used to obtain the actual reply. Any error generated by the X server in response to this request will be returned through any supplied error pointer in the corresponding Reply function rather than being placed in the event queue. If no error pointer is supplied, the error will be discarded.
+If the request will cause a reply to be generated, then an [`xcb_name_cookie_t`](#xcb_name_cookie_t) will be returned and the [`xcb_name_reply_t`](#xcb_name_reply_t) function should be used to obtain the actual reply. Any error generated by the X server in response to this request will be returned through any supplied error pointer in the corresponding Reply function rather than being placed in the event queue. If no error pointer is supplied, the error will be discarded.
 
-Otherwise, an [xcb_void_cookie_t](#xcb_name_cookie_t) will be returned, and no [xcb_name_reply_t](#xcb_name_reply_t) function will be provided. Any error generated by the X server in response to this request will be placed in the event queue.
+Otherwise, an [`xcb_void_cookie_t`](#xcb_name_cookie_t) will be returned, and no [`xcb_name_reply_t`](#xcb_name_reply_t) function will be provided. Any error generated by the X server in response to this request will be placed in the event queue.
 
 <a name="xcb_name_checked"></a>
 
@@ -152,7 +152,7 @@ Otherwise, an [xcb_void_cookie_t](#xcb_name_cookie_t) will be returned, and no [
 
 Delivers a request with the specified arguments to the X server.
 
-This form can be used only if the request will not cause a reply to be generated. It behaves as `xcb_name`, except that any returned error will be saved for handling by [xcb_request_check()](#xcb_request_check) rather than being placed in the event queue.
+This form can be used only if the request will not cause a reply to be generated. It behaves as `xcb_name`, except that any returned error will be saved for handling by [`xcb_request_check()`](#xcb_request_check) rather than being placed in the event queue.
 
 <a name="xcb_name_unchecked"></a>
 
@@ -163,7 +163,7 @@ This form can be used only if the request will not cause a reply to be generated
 
 Delivers a request with the specified arguments to the X server.
 
-This form can be used only if the request will cause a reply to be generated. It behaves as `xcb_name`, except that any returned error will be placed in the event queue rather than being handled by [xcb_name_reply()](#xcb_name_reply).
+This form can be used only if the request will cause a reply to be generated. It behaves as `xcb_name`, except that any returned error will be placed in the event queue rather than being handled by [`xcb_name_reply()`](#xcb_name_reply).
 
 <a name="xcb_name_reply"></a>
 
@@ -174,7 +174,7 @@ This form can be used only if the request will cause a reply to be generated. It
 						 xcb_name_cookie_t cookie,
 						 xcb_generic_error_t **e );
 
-The `xcb_generic_error_t **e` supplied to this function must be 0 unless the corresponding request function committed to storing an error here. See [xcb_name()](#xcb_name), [xcb_name_checked()](#xcb_name_checked), and [xcb_name_unchecked()](#xcb_name_unchecked).
+The `xcb_generic_error_t **e` supplied to this function must be 0 unless the corresponding request function committed to storing an error here. See [`xcb_name()`](#xcb_name), [`xcb_name_checked()`](#xcb_name_checked), and [`xcb_name_unchecked()`](#xcb_name_unchecked).
 
 <a name="xcb_request_check"></a>
 
@@ -184,7 +184,7 @@ The `xcb_generic_error_t **e` supplied to this function must be 0 unless the cor
 		xcb_request_check (xcb_connection_t *c,
 						   xcb_void_cookie_t cookie );
 
-The `xcb_void_cookie_t cookie` supplied to this function must have resulted from a call to [xcb_name_checked()](#xcb_name_checked). This function will block until one of two conditions happens. If an error is received, it will be returned. If no error can be received, because the sequence number has advanced beyond that provided in `cookie`, 0 will be returned.
+The `xcb_void_cookie_t cookie` supplied to this function must have resulted from a call to [`xcb_name_checked()`](#xcb_name_checked). This function will block until one of two conditions happens. If an error is received, it will be returned. If no error can be received, because the sequence number has advanced beyond that provided in `cookie`, 0 will be returned.
 
 /!\ Note that this function will perform an `xcb_aux_sync()` if needed to ensure that the sequence number will advance beyond that provided in `cookie`; this is a convenience to avoid races in determining whether the sync is needed. If you want a version of this call that never performs this implicit sync (e.g. because you are writing in a multi-threaded implementation in which another thread will eventually issue a request), please let us know, and we will consider adding it.
 
@@ -220,9 +220,9 @@ The `xcb_void_cookie_t cookie` supplied to this function must have resulted from
 	         /* padding to 32 bytes */
 		} xcb_event_name_event_t;
 
-`response_type` equals the event number. See [XCB_EVENT_NAME](#XCB_EVENT_NAME).
+`response_type` equals the event number. See [`XCB_EVENT_NAME`](#XCB_EVENT_NAME).
 
-A special event type, xcb_generic_event_t, is declared in xcb.h. It contains only the fields common to all events.
+A special event type, `xcb_generic_event_t`, is declared in xcb.h. It contains only the fields common to all events.
 
 <a name="XCB_EVENT_NAME"></a>
 
@@ -242,9 +242,9 @@ A special event type, xcb_generic_event_t, is declared in xcb.h. It contains onl
 
 `response_type` always equals 0 for errors.
 
-`error_code` equals the error number. See [XCB_ERROR_NAME](#XCB_ERROR_NAME).
+`error_code` equals the error number. See [`XCB_ERROR_NAME`](#XCB_ERROR_NAME).
 
-A special error type, xcb_generic_error_t, is declared in xcb.h. It contains only the fields common to all errors.
+A special error type, `xcb_generic_error_t`, is declared in xcb.h. It contains only the fields common to all errors.
 
 <a name="XCB_ERROR_NAME"></a>

More information about the xcb-commit mailing list