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

ta12200.h: adding doxygen tags

Browse Source 
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
John Van Drasek 2015-03-20 17:16:39 -07:00
parent 1e7f1f7cf2
commit 7f30553a51
1 changed files with 29 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
src/ta12200/ta12200.h
View File

@ -33,18 +33,35 @@
#define TA12200_ADC_RES 1024
namespace upm {
/**
* @brief C++ API for the TA12-200 current transformer
*
* UPM module for the TA12-200 current transformer, which is found,
* for instance, in the Grove Electricity Sensor.
* This module can measure AC current moving through a wire at up
* to 5A.
*
* @ingroup analog
* @snippet ta12200.cxx Interesting
*/
/**
* @brief C++ API for the TA12-200 current transformer
*
* UPM module for the TA12-200 current transformer, which is found,
* for instance, in the Grove Electricity Sensor.
* This module can measure AC current moving through a wire at up
* to 5A.
*
* @defgroup ta12200 libupm-ta12200
* @ingroup seeed analog electric
*/
/**
* @library ta12200
* @sensor ta12200
* @comname Current transformer
* @type electric
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Electricity_Sensor
* @con analog
*
* @brief C++ API for the TA12-200 current transformer
*
* UPM module for the TA12-200 current transformer, which is found,
* for instance, in the Grove Electricity Sensor.
* This module can measure AC current moving through a wire at up
* to 5A.
*
* @snippet ta12200.cxx Interesting
*/
class TA12200 {
public:
/**