diff options
| author | Cyril Brulebois <kibi@debian.org> | 2011-06-06 02:20:44 +0200 |
|---|---|---|
| committer | Cyril Brulebois <kibi@debian.org> | 2011-06-06 17:05:47 +0200 |
| commit | 1e37fb24b0a9463a7136bd34ea798a8443a812d9 (patch) | |
| tree | 80a368da538fca019ad3fcc568f8df7b6ed8e5a2 | |
| parent | c1b15a40345313b2739e2d0df83d278dec943dfb (diff) | |
doc: Try to mention all parameters [FIXME].doc-master
The FIXME in the title is intentional, a hunk needs some intel:
a description of the 3 last parameters to the
InitStringFeedbackClassDeviceStruct() function.
Thanks already!
Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Reviewed-by: Daniel Stone <daniel@fooishbar.org>
Signed-off-by: Cyril Brulebois <kibi@debian.org>
| -rw-r--r-- | doc/Xinput.xml | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/Xinput.xml b/doc/Xinput.xml index 4f79f34f1..b22938197 100644 --- a/doc/Xinput.xml +++ b/doc/Xinput.xml @@ -504,7 +504,8 @@ have buttons. <para> <!-- .LP --> This function is provided to allocate and initialize a ValuatorClassRec, and -should be called for extension devices that have valuators. It is passed the +should be called for extension devices that have valuators. It is passed +a pointer to the device, the number of axes of motion reported by the device, the address of the motion history procedure for the device, the size of the motion history buffer, and the mode (Absolute or Relative) of the device. It returns FALSE if @@ -543,7 +544,7 @@ the InitValuatorClassDeviceStruct function, but is not initialized. <!-- .LP --> InitValuatorAxisStruct should be called once for each axis of motion reported by the device. Each -invocation should be passed the axis number (starting with 0), the +invocation should be passed a pointer to the device, the axis number (starting with 0), the minimum value for that axis, the maximum value for that axis, and the resolution of the device in counts per meter. If the device reports relative motion, 0 should be reported as the minimum and maximum values. @@ -688,6 +689,7 @@ multiple feedbacks of the same type. This function is provided to allocate and initialize a BellFeedbackClassRec, and should be called for extension devices that have a bell. It is passed a pointer to the device, +a pointer to the procedure that sounds the bell, and a pointer to the device control procedure. It returns FALSE if the allocation fails, and has the following parameters: <literallayout class="monospaced"> @@ -708,7 +710,9 @@ This function is provided to allocate and initialize a StringFeedbackClassRec, and should be called for extension devices that have a display upon which a string can be displayed. It is passed a pointer to the device, -and a pointer to the device control procedure. +a pointer to the device control procedure, +<!-- FIXME --> +and three more parameters to be documented. It returns FALSE if the allocation fails, and has the following parameters: <literallayout class="monospaced"> Bool |