alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-10-29 22:24:48 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

8
src/enc03r/enc03r.h
View File

@@ -126,20 +126,20 @@ extern "C" {
float enc03r_angular_velocity(const enc03r_context dev);
/**
* Set sensor offset. The offste is applied to the return value
* Set sensor offset. The offset is applied to the return value
* before scaling. Default is 0.
*
* @param dev Device context
* @param scale Scale to apply to value
* @param offset Offset to apply to value
*/
void enc03r_set_offset(const enc03r_context dev, float offset);
/**
* Set sensor scale. The return value is scaled by this value
* before the offset is applied. Default is 1.0.
* after the offset is applied. Default is 1.0.
*
* @param dev Device context
* @param scale Offset to apply to value
* @param scale Scale to apply to value
*/
void enc03r_set_scale(const enc03r_context dev, float scale);

11
src/enc03r/enc03r.hpp
View File

@@ -60,7 +60,7 @@ class ENC03R {
* ENC03R sensor constructor
*
* @param pin Analog pin to use
* @param vref Reference voltage to use; default is 5.0 V
* @param aref Reference voltage to use; default is 5.0 V
*/
ENC03R(int pin, float aref=5.0);
@@ -104,19 +104,18 @@ class ENC03R {
float angularVelocity();
/**
* Set sensor offset. The offste is applied to the return value
* Set sensor offset. The offset is applied to the return value
* before scaling. Default is 0.
*
* @param scale Scale to apply to value
* @param offset Offset to apply to value
*/
void setOffset(float offset);
/**
* Set sensor scale. The return value is scaled by this value
* before the offset is applied. Default is 1.0.
* after the offset is applied. Default is 1.0.
*
* @param dev Device context
* @param scale Offset to apply to value
* @param scale Scale to apply to value
*/
void setScale(float scale);