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

docs: updated doxygen tags for some sensors

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2016-08-04 15:43:20 -07:00
parent 49e04593d8
commit d79799bab9
5 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/groveultrasonic/groveultrasonic.hpp
View File

@ -38,7 +38,7 @@ namespace upm {
/** /**
* @brief Grove ultrasonic sensor library * @brief Grove ultrasonic sensor library
* @defgroup groveultrasonic libupm-groveultrasonic * @defgroup groveultrasonic libupm-groveultrasonic
* @ingroup grove gpio sound * @ingroup seeed gpio sound
*/ */
/** /**

4
src/mg811/mg811.hpp
View File

@ -32,7 +32,7 @@ namespace upm {
/** /**
* @brief DFRobot CO2 Sensor * @brief DFRobot CO2 Sensor
* @defgroup mg811 libupm-mg811 * @defgroup mg811 libupm-mg811
* @ingroup dfrobot analog gas * @ingroup dfrobot analog gaseous
*/ */
/** /**
@ -40,7 +40,7 @@ namespace upm {
* @sensor mg811 * @sensor mg811
* @comname DFRobot CO2 Sensor * @comname DFRobot CO2 Sensor
* @altname MG811 * @altname MG811
* @type gas * @type gaseous
* @man dfrobot * @man dfrobot
* @web http://www.dfrobot.com/index.php?route=product/product&product_id=1023 * @web http://www.dfrobot.com/index.php?route=product/product&product_id=1023
* @con analog * @con analog

2
src/t6713/t6713.cxx
View File

@ -1,5 +1,5 @@
/* /*
* Author: HCL * Author: Henry Bruce <henry.bruce@intel.com>
* Copyright (c) 2015 Intel Corporation. * Copyright (c) 2015 Intel Corporation.
* *
* Permission is hereby granted, free of charge, to any person obtaining * Permission is hereby granted, free of charge, to any person obtaining

22
src/t6713/t6713.hpp
View File

@ -1,5 +1,5 @@
/* /*
* Author: HCL * Author: Henry Bruce <henry.bruce@intel.com>
* Copyright (c) 2015 Intel Corporation. * Copyright (c) 2015 Intel Corporation.
* *
* Permission is hereby granted, free of charge, to any person obtaining * Permission is hereby granted, free of charge, to any person obtaining
@ -31,16 +31,10 @@ namespace upm {
/** /**
* @brief Amphenol Telaire 6713 Series CO2 Module * @brief Amphenol Telaire 6713 Series CO2 Module
* @defgroup t6713 libupm-t6713 * @defgroup t6713 libupm-t6713
* @ingroup i2c telaire gas ico2sensor * @ingroup i2c amphenol gaseous ico2sensor
*/ */
/** /**
* @brief C++ API for Amphenol Telaire 6713 Series CO2 Module
*
* The Telaire 6713 Series CO2 Module
* [6713](http://amphenol-sensors.com/en/products/co2/co2-modules/3215-t6700#specifications-t6713)
* is a CO2 Module sensor.
*
* @library t6713 * @library t6713
* @sensor t6713 * @sensor t6713
* @comname Telaire 6713 Series CO2 Module * @comname Telaire 6713 Series CO2 Module
@ -48,8 +42,16 @@ namespace upm {
* @type gaseous * @type gaseous
* @man amphenol * @man amphenol
* @con i2c * @con i2c
* @if ic02sensor * @if ico2sensor
*
* @brief C++ API for Amphenol Telaire 6713 Series CO2 Module
*
* The Telaire 6713 Series CO2 Module
* [6713](http://amphenol-sensors.com/en/products/co2/co2-modules/3215-t6700#specifications-t6713)
* is a CO2 Module sensor.
*
* @snippet t6713.cxx Interesting
* @snippet co2-sensor.cxx Interesting
*/ */
namespace t6713_co2 namespace t6713_co2
{ {

2
src/upm.h
View File

@ -269,7 +269,7 @@
/** /**
* @brief Implements ICOSensor * @brief Implements ICOSensor
* @defgroup ic02sensor ICOSensor * @defgroup ico2sensor ICOSensor
* @ingroup byif * @ingroup byif
*/ */