rozkuk: Code revision and clarification (possibly not compilable for ppc).

[eurobot/public.git] / src / camera / rozkuk / clr2float.h

diff --git a/src/camera/rozkuk/clr2float.h b/src/camera/rozkuk/clr2float.h
index 75383017810668f6bf1006b902a5e83032be325c..60c9278897dee31bd14355ec98977f2cf0c46125 100644 (file)
--- a/src/camera/rozkuk/clr2float.h
+++ b/src/camera/rozkuk/clr2float.h
@@ -19,10 +19,12 @@
   * @param src Image in BGR format.
   * @param dest Pointer to a destination matrix.
   * @param threshold Level of gray which will transform to zero.
-  * @param k Saturation - if k>1.0, differences between positive and negative values grow.
+  * @param k Saturation - if k>1.0, differences between positive
+  *  and negative values grow.
   * @param thresholded If not NULL, BW thresholded version of src is stored here.
-  * @return Length of the destination data, or 0 if an error occurs. */
-int clr2float(const IplImage *src, CvMat **dest, unsigned char threshold, float k=1.0, IplImage *thresholded=NULL);
+  * @return Length of the destination data, or negative if an error occurs. */
+int clr2float(const IplImage *src, CvMat **dest, unsigned char threshold,
+               float k=1.0, IplImage *thresholded=NULL);
 
 /******************************************************************************/