Diff: src/CayenneMQTTClient/CayenneMQTTClient.h

Revision:

2:c0419dbecfbd

Parent:

1:90dccf306268

Child:

3:b5f895caeeb0

diff -r 90dccf306268 -r c0419dbecfbd src/CayenneMQTTClient/CayenneMQTTClient.h
--- a/src/CayenneMQTTClient/CayenneMQTTClient.h	Fri Oct 07 22:24:51 2016 +0000
+++ b/src/CayenneMQTTClient/CayenneMQTTClient.h	Fri Oct 07 22:38:26 2016 +0000
@@ -26,15 +26,18 @@
 
 namespace Cayenne
 {
+	/**
+	* Cayenne message data passed to message handler functions.
+	*/
 	typedef struct MessageData
 	{
-		const char* clientID;
-		CayenneTopic topic;
-		unsigned int channel;
-		const char* id;
-		const char* type;
-		CayenneValuePair values[CAYENNE_MAX_MESSAGE_VALUES];
-		size_t valueCount;
+		const char* clientID; //**< The client ID of the message.*/
+		CayenneTopic topic; //**< The topic the message was received on.*/
+		unsigned int channel; //**< The channel the message was received on.*/
+		const char* id; //**< The message ID, if it is a command message, otherwise NULL.*/
+		const char* type; //**< The type of data in the message, if it exists, otherwise NULL.*/
+		CayenneValuePair values[CAYENNE_MAX_MESSAGE_VALUES]; //**< The unit/value data pairs in the message. Can be NULL.*/
+		size_t valueCount; //**< The count of items in the values array.*/
 	} MessageData;
 	
 	/**