From 05435eed4fa2d80ffd34a2441aca500c3f1b5d9f Mon Sep 17 00:00:00 2001 From: Noel Eck Date: Mon, 20 Mar 2017 10:28:38 -0700 Subject: [PATCH] docs: Small updates to descriptions. Updated descriptions on four headers. One header needed a description. Replaced 'driver' with 'library' on the other three. Signed-off-by: Noel Eck --- src/biss0001/biss0001.hpp | 7 ++++++- src/dfrorp/dfrorp.hpp | 2 +- src/mma7361/mma7361.hpp | 2 +- src/urm37/urm37.hpp | 2 +- 4 files changed, 9 insertions(+), 4 deletions(-) diff --git a/src/biss0001/biss0001.hpp b/src/biss0001/biss0001.hpp index 7176bb24..9d487aa9 100644 --- a/src/biss0001/biss0001.hpp +++ b/src/biss0001/biss0001.hpp @@ -46,7 +46,12 @@ namespace upm { * * @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 * @snippet biss0001.cxx Interesting diff --git a/src/dfrorp/dfrorp.hpp b/src/dfrorp/dfrorp.hpp index 5165c479..ec61ade1 100644 --- a/src/dfrorp/dfrorp.hpp +++ b/src/dfrorp/dfrorp.hpp @@ -51,7 +51,7 @@ namespace upm { * * @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. * * To calibrate: diff --git a/src/mma7361/mma7361.hpp b/src/mma7361/mma7361.hpp index f87cd685..a2739e04 100644 --- a/src/mma7361/mma7361.hpp +++ b/src/mma7361/mma7361.hpp @@ -50,7 +50,7 @@ namespace upm { * * @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 * sensitivity. * diff --git a/src/urm37/urm37.hpp b/src/urm37/urm37.hpp index 40ef6266..ff53a7d2 100644 --- a/src/urm37/urm37.hpp +++ b/src/urm37/urm37.hpp @@ -53,7 +53,7 @@ namespace upm { * * @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 * supports both analog distance measurement, and UART based * temperature and distance measurements. This driver does not