alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-15 04:57:30 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Small updates to descriptions.

Browse Source 
Updated descriptions on four headers.  One header needed a description.
Replaced 'driver' with 'library' on the other three.

Signed-off-by: Noel Eck <noel.eck@intel.com>
This commit is contained in:
Noel Eck 2017-03-20 10:28:38 -07:00
parent 54a84af1c3
commit 05435eed4f
4 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/biss0001/biss0001.hpp
View File

@ -46,7 +46,12 @@ namespace upm {
* *
* @brief API for the BISS0001 Motion Sensor * @brief API for the BISS0001 Motion Sensor
* *
* UPM module for the BISS0001 Motion Sensor * PIR sensors allow you to sense motion, almost always used to detect
* whether a human has moved in or out of the sensors range. They are
* small, inexpensive, low-power, easy to use and don't wear out. For that
* reason they are commonly found in appliances and gadgets used in homes
* or businesses. They are often referred to as PIR, "Passive Infrared",
* "Pyroelectric", or "IR motion" sensors.
* *
* @image html biss0001.jpg * @image html biss0001.jpg
* @snippet biss0001.cxx Interesting * @snippet biss0001.cxx Interesting

2
src/dfrorp/dfrorp.hpp
View File

@ -51,7 +51,7 @@ namespace upm {
* *
* @brief API for the DFRobot ORP (Oxidation/Reduction Potential) Sensor * @brief API for the DFRobot ORP (Oxidation/Reduction Potential) Sensor
* *
* The driver was tested with the DFRobot ORP (Oxidation/Reduction * This library was tested with the DFRobot ORP (Oxidation/Reduction
* Potential) Sensor. * Potential) Sensor.
* *
* To calibrate: * To calibrate:

2
src/mma7361/mma7361.hpp
View File

@ -50,7 +50,7 @@ namespace upm {
* *
* @brief API for the DFRobot MMA7361 Analog Accelerometer * @brief API for the DFRobot MMA7361 Analog Accelerometer
* *
* The driver was tested with the DFRobot MMA7361 Analog * This library was tested with the DFRobot MMA7361 Analog
* Accelerometer. It supports 3 Axes with a selectable 1.5G and 6G * Accelerometer. It supports 3 Axes with a selectable 1.5G and 6G
* sensitivity. * sensitivity.
* *

2
src/urm37/urm37.hpp
View File

@ -53,7 +53,7 @@ namespace upm {
* *
* @brief API for the DFRobot URM37 Ultrasonic Ranger * @brief API for the DFRobot URM37 Ultrasonic Ranger
* *
* The driver was tested with the DFRobot URM37 Ultrasonic Ranger, * This library was tested with the DFRobot URM37 Ultrasonic Ranger,
* V4. It has a range of between 5 and 500 centimeters (cm). It * V4. It has a range of between 5 and 500 centimeters (cm). It
* supports both analog distance measurement, and UART based * supports both analog distance measurement, and UART based
* temperature and distance measurements. This driver does not * temperature and distance measurements. This driver does not