Created attachment 69542 [details] [review]
Better documentation for {set,get}Contrast methods

This try to explaim better what {set,get}Contrast methods does. I quick way to test them is using the test/control-client program like this: # ./control-client C 1 0 0
Where 1 0 0 are the Red, Green and Blue values.

Carlos, thanks for the clarification.  I still am a little unsure of the intended result, as this feature doesn't seem to work as advertised at the moment; 

setting control-client C 0.5 0.5 5.0 does not result in
R,G,B of 0.5,0.5,5.0 being set or returned by Magnifier_getContrast.
see bug #348629.

I see.  I have commented (in the other bug? or was it in email) about the fact that this method doesn't work as one expects, changing the contrast also changes the brightness a lot.  

I think this should be fixed before we fix the documentation.  But in any case the docs should indicate the valid ranges of the parameters if it's not obvious from the description, and should indicate what the expected effect on the R,G,B channels should be.  It would be enough, I think, to describe the actual algorithm for changing R,G,B based on the parameters.

Created attachment 78357 [details] [review]
contrast documentation accordingly the new patch in bug #348629

Fixed in the development version. The fix will be available in the next major release. Thank you for your bug report.