docs: updated @param tags, added missing function descriptions, other minor changes

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2017-04-10 16:59:39 -07:00
parent 39df7fd10f
commit 3aef2ea70e
94 changed files with 327 additions and 222 deletions

View File

@ -63,8 +63,6 @@ class HCSR04 {
*
* @param triggerPin Pin to trigger the sensor for distance
* @param echoPin Pulse response to triggering
* @param fptr Function pointer to handle rising-edge and
* falling-edge interrupts
*/
HCSR04 (int triggerPin, int echoPin);
/**
@ -74,6 +72,8 @@ class HCSR04 {
/**
* Gets the distance from the sensor
*
* @param sys Selects units for measurement: 0 = inch, 1 = cm
*/
double getDistance (int sys);