docs: updated library descriptions and sensor names for consistency

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2015-06-01 15:44:07 -07:00
parent 8965d56c93
commit 14f80e779e
97 changed files with 237 additions and 246 deletions

View File

@ -55,8 +55,9 @@ namespace upm {
/**
* @library mhz16
* @sensor mhz16
* @comname Grove CO2 sensor
* @sensor mhz16
* @comname Grove CO2 Sensor
* @altname MHZ16 Serial CO2 Sensor
* @type gaseous
* @man seeed
* @con uart
@ -67,14 +68,14 @@ namespace upm {
*
* It's CO2 detection ranges from 0PPM to 2000PPM. It requires a
* 2-3 minute warm up time before reporting valid data.
*
*
* @image html mhz16.jpg
* @snippet mhz16.cxx Interesting
*/
class MHZ16 {
public:
/**
* MHZ16 module constructor
*
@ -120,7 +121,7 @@ namespace upm {
* setup the proper tty i/o modes and the baudrate. The default
* baud rate is 9600 (B9600).
*
* @param baud the desired baud rate.
* @param baud the desired baud rate.
* @return true if successful
*/
bool setupTty(speed_t baud=B9600);