Update documentation for IR sensor functions.

piedar · piedar · commit ad5b98de90cc · 2015-10-18T14:14:08.000-04:00
Signed-off-by: Benn Snyder &lt;benn.snyder@gmail.com&gt;
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

Original file line number	Diff line number	Diff line change
`@@ -671,7 +671,7 @@ FREENECTAPI int freenect_set_depth_mode(freenect_device* dev, const freenect_fra`
`671`	`671`	`FREENECTAPI int freenect_set_flag(freenect_device *dev, freenect_flag flag, freenect_flag_value value);`
`672`	`672`
`673`	`673`	`/**`
`674`		`- * Returns the brightness of the IR projector`
	`674`	`+ * Returns the brightness of the IR sensor.`
`675`	`675`	`*`
`676`	`676`	`* @param dev Device to get IR brightness`
`677`	`677`	`*`
`@@ -680,7 +680,8 @@ FREENECTAPI int freenect_set_flag(freenect_device *dev, freenect_flag flag, free`
`680`	`680`	`FREENECTAPI int freenect_get_ir_brightness(freenect_device *dev);`
`681`	`681`
`682`	`682`	`/**`
`683`		`- * Sets the brightness of the IR projector`
	`683`	`+ * Sets the brightness of the IR sensor.`
	`684`	`+ * Note that this does not change the intensity of the IR projector.`
`684`	`685`	`*`
`685`	`686`	`* @param dev Device to set IR brightness`
`686`	`687`	`* @param brighness Brightness value in range 1 - 50`