Skip to content

Commit 180b157

Browse files
author
brentru
committed
doxy AdafruitIO_Definitions
1 parent 0c581ab commit 180b157

1 file changed

Lines changed: 19 additions & 3 deletions

File tree

src/AdafruitIO_Definitions.h

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,37 @@ typedef void (*AdafruitIODataCallbackType)(AdafruitIO_Data *data); /*!< Data cal
3333
/**************************************************************************/
3434
class AdafruitIOGroupCallback {
3535
public:
36+
/**************************************************************************/
37+
/*!
38+
@brief Sets up MQTT Group callbacks.
39+
@param f
40+
Valid Adafruit IO feed key.
41+
@param cb
42+
Adafruit IO MQTT callback.
43+
*/
44+
/**************************************************************************/
3645
AdafruitIOGroupCallback(const char *f, AdafruitIODataCallbackType cb) {
3746
feed = f;
3847
dataCallback = cb;
3948
next_cb = 0;
4049
}
4150

51+
/**************************************************************************/
52+
/*!
53+
@brief Sets up MQTT Group callbacks.
54+
@param cb
55+
Adafruit IO MQTT callback.
56+
*/
57+
/**************************************************************************/
4258
AdafruitIOGroupCallback(AdafruitIODataCallbackType cb) {
4359
feed = 0;
4460
dataCallback = cb;
4561
next_cb = 0;
4662
}
4763

48-
const char *feed;
49-
AdafruitIODataCallbackType dataCallback; // data carried by an AdafruitIOGroupCallback
50-
AdafruitIOGroupCallback *next_cb; // next callback number
64+
const char *feed; /*!< Adafruit IO feed name. */
65+
AdafruitIODataCallbackType dataCallback ; /*!< data carried by an AdafruitIOGroupCallback. */
66+
AdafruitIOGroupCallback *next_cb; /*!< Next callback number. */
5167
};
5268

5369
// Uncomment/comment to turn on/off debug output messages.

0 commit comments

Comments
 (0)