alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-02 09:51:14 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

doxygen: updated descriptions to clean up @con tags for xml generation

Browse Source 
This ensures the generated xml paragraphs for the connection field won't have nested children and hence should be readable by the ISS parser properly

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2018-02-13 10:19:14 -08:00
parent 38817b72dc
commit a12baf379f
37 changed files with 82 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/grove/grovebutton.hpp
View File

@ -33,6 +33,8 @@
namespace upm {
/**
* @deprecated This class is being replaced by the upm-button library and the
* Button class.
* @library grove
* @sensor grovebutton
* @comname Button
@ -41,8 +43,6 @@ namespace upm {
* @man seeed
* @con gpio
* @kit gsk
* @deprecated This class is being replaced by the upm-button library and the
* Button class.
*
* @brief API for the Grove Button
*

4
src/grove/groveled.hpp
View File

@ -33,6 +33,8 @@
namespace upm {
/**
* @deprecated This class is being replaced by the upm-led library and the
* Led class.
* @library grove
* @sensor groveled
* @comname LED
@ -40,8 +42,6 @@ namespace upm {
* @man seeed
* @con gpio
* @kit gsk
* @deprecated This class is being replaced by the upm-led library and the
* Led class.
*
* @brief API for the Grove LED
*

4
src/grove/grovelight.hpp
View File

@ -33,6 +33,8 @@
namespace upm {
/**
* @deprecated This class is being replaced by the upm-light library and the
* Light class.
* @library grove
* @sensor grovelight
* @comname Light Sensor
@ -40,8 +42,6 @@ namespace upm {
* @man seeed
* @con analog
* @kit gsk
* @deprecated This class is being replaced by the upm-light library and the
* Light class.
*
* @brief API for the Grove Light Sensor
*

4
src/grove/groverelay.hpp
View File

@ -33,6 +33,8 @@
namespace upm {
/**
* @deprecated This class is being replaced by the upm-relay library and the
* Relay class.
* @library grove
* @sensor groverelay
* @comname Relay
@ -40,8 +42,6 @@ namespace upm {
* @man seeed
* @con gpio
* @kit gsk eak hak
* @deprecated This class is being replaced by the upm-relay library and the
* Relay class.
*
* @brief API for the Grove Relay
*

4
src/grove/groverotary.hpp
View File

@ -33,6 +33,8 @@
namespace upm {
/**
* @deprecated This class is being replaced by the upm-rotary library and the
* Rotary class.
* @library grove
* @sensor groverotary
* @comname Rotary Angle Sensor
@ -41,8 +43,6 @@ namespace upm {
* @man seeed
* @con analog
* @kit gsk
* @deprecated This class is being replaced by the upm-rotary library and the
* Rotary class.
*
* @brief API for the Grove Rotary Angle Sensor (Knob)
*

4
src/grove/groveslide.hpp
View File

@ -33,14 +33,14 @@
namespace upm {
/**
* @deprecated This class is being replaced by the upm-slide library and the
* Slide class.
* @library grove
* @sensor groveslide
* @comname Slide Potentiometer
* @type ainput
* @man seeed
* @con analog
* @deprecated This class is being replaced by the upm-slide library and the
* Slide class.
*
* @brief API for the Grove Slide Potentiometer
*

4
src/grove/grovetemp.hpp
View File

@ -33,6 +33,8 @@
namespace upm {
/**
* @deprecated This class is being replaced by the upm-temperature library and
* the Temperature class.
* @library grove
* @sensor grovetemp
* @comname Temperature Sensor
@ -40,8 +42,6 @@ namespace upm {
* @man seeed
* @con analog
* @kit gsk
* @deprecated This class is being replaced by the upm-temperature library and
* the Temperature class.
*
* @brief API for the Grove Temperature Sensor
*