Update documentation for IR sensor functions.

Signed-off-by: Benn Snyder <benn.snyder@gmail.com>
OpenKinect · Oct 18, 2015 · ad5b98d · ad5b98d
1 parent dcb2929
commit ad5b98d
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/include/libfreenect.h b/include/libfreenect.h
@@ -671,7 +671,7 @@ FREENECTAPI int freenect_set_depth_mode(freenect_device* dev, const freenect_fra
 FREENECTAPI int freenect_set_flag(freenect_device *dev, freenect_flag flag, freenect_flag_value value);
 
 /**
- * Returns the brightness of the IR projector
+ * Returns the brightness of the IR sensor.
  *
  * @param dev Device to get IR brightness
  *
@@ -680,7 +680,8 @@ FREENECTAPI int freenect_set_flag(freenect_device *dev, freenect_flag flag, free
 FREENECTAPI int freenect_get_ir_brightness(freenect_device *dev);
 
 /**
- * Sets the brightness of the IR projector
+ * Sets the brightness of the IR sensor.
+ * Note that this does not change the intensity of the IR projector.
  *
  * @param dev Device to set IR brightness
  * @param brighness Brightness value in range 1 - 50