[PATCH v2 02/12] dox: Update documentation to match the extended API
Pauli
ext-pauli.nieminen at nokia.com
Tue Jan 4 03:06:23 PST 2011
From: Pauli Nieminen <ext-pauli.nieminen at nokia.com>
Block and Wakeup hanler API was extended to register both type of
handlers separately. Update the documentation to reflect the new API.
Signed-off-by: Pauli Nieminen <ext-pauli.nieminen at nokia.com>
---
doc/xml/Xserver-spec.xml | 42 ++++++++++++++++++++++++++++++++++++++++--
1 files changed, 40 insertions(+), 2 deletions(-)
diff --git a/doc/xml/Xserver-spec.xml b/doc/xml/Xserver-spec.xml
index 563705f..9bbe07e 100644
--- a/doc/xml/Xserver-spec.xml
+++ b/doc/xml/Xserver-spec.xml
@@ -746,8 +746,8 @@ block and wakeup handlers (only together) using:
</programlisting>
</blockquote>
A FALSE return code indicates that the registration failed for lack of
-memory. To remove a registered Block handler at other than server reset time
-(when they are all removed automatically), use:
+memory. To remove a registered Block and Wakeup handler at other than server
+reset time (when they are all removed automatically), use:
<blockquote>
<programlisting>
RemoveBlockAndWakeupHandlers (blockHandler, wakeupHandler, blockData)
@@ -760,6 +760,44 @@ All three arguments must match the values passed to
RegisterBlockAndWakeupHandlers.
</para>
<para>
+<programlisting>
+ Bool RegisterBlockHandler (blockHandler, blockData)
+ BlockHandlerProcPtr blockHandler;
+ pointer blockData;
+</programlisting>
+</blockquote>
+A FALSE return code indicates that the registration failed for lack of
+memory. To remove a registered Block handler at other than server reset time
+(when they are all removed automatically), use:
+<blockquote>
+<programlisting>
+ RemoveBlockHandler (blockHandler, blockData)
+ BlockHandlerProcPtr blockHandler;
+ pointer blockData;
+</programlisting>
+</blockquote>
+Both arguments must match the values passed to RegisterBlockHandler.
+</para>
+<para>
+<programlisting>
+ Bool RegisterWakeupHandler (wakeupHandler, blockData)
+ WakeupHandlerProcPtr wakeupHandler;
+ pointer blockData;
+</programlisting>
+</blockquote>
+A FALSE return code indicates that the registration failed for lack of
+memory. To remove a registered Wakeup handler at other than server reset time
+(when they are all removed automatically), use:
+<blockquote>
+<programlisting>
+ RemoveWakeupHandler (wakeupHandler, blockData)
+ WakeupHandlerProcPtr wakeupHandler;
+ pointer blockData;
+</programlisting>
+</blockquote>
+Both arguments must match the values passed to RegisterWakeupHandler.
+</para>
+<para>
These registered block handlers are called after the per-screen handlers:
<blockquote>
<programlisting>
--
1.7.0.4
More information about the xorg-devel
mailing list