Re: [PATCH 14/14] doc: Try to mention all parameters [FIXME].

[Daniel Stone]

Hi,

On Mon, Jun 06, 2011 at 02:25:12AM +0200, Cyril Brulebois wrote:
> 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!

max_symbols: largest number of characters that can be displayed by the
 LED (or whatever) at one time
num_symbols_supported: size of symbols (see below)
symbols: list of KeySyms the LED (or whatever) is able to display

Assuming Jamey's comment gets fixed, then for the series:
Reviewed-by: Daniel Stone 

Cheers,
Daniel
___
xorg-devel@lists.x.org: X.Org development
Archives: http://lists.x.org/archives/xorg-devel
Info: http://lists.x.org/mailman/listinfo/xorg-devel

[PATCH 14/14] doc: Try to mention all parameters [FIXME].

[Cyril Brulebois]

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!

Signed-off-by: Cyril Brulebois 
---
 doc/Xinput.xml |   10 +++---
 1 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/doc/Xinput.xml b/doc/Xinput.xml
index 4f79f34..b229381 100644
--- a/doc/Xinput.xml
+++ b/doc/Xinput.xml
@@ -504,7 +504,8 @@ have buttons.
 
 
 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.
 
 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:
 
@@ -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,
+
+and three more parameters to be documented.
 It returns FALSE if the allocation fails, and has the following parameters:
 
 Bool
-- 
1.7.5.3

___
xorg-devel@lists.x.org: X.Org development
Archives: http://lists.x.org/archives/xorg-devel
Info: http://lists.x.org/mailman/listinfo/xorg-devel