Revision 4:421366004b5d, committed 2016-10-07

Comitter:

jburhenn

Date:

Fri Oct 07 22:44:16 2016 +0000

Parent:

3:b5f895caeeb0

Child:

5:363211a8995f

Child:

6:82e142a864ad

Commit message:

Updated documentation comments.

Changed in this revision

--- a/src/CayenneMQTTClient/CayenneMQTTClient.h	Fri Oct 07 22:41:27 2016 +0000
+++ b/src/CayenneMQTTClient/CayenneMQTTClient.h	Fri Oct 07 22:44:16 2016 +0000
@@ -31,13 +31,13 @@
 	*/
 	typedef struct MessageData
 	{
-		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. The units and values can be NULL. */
-		size_t valueCount; //**< The count of items in the values array. */
+		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. The units and values can be NULL. */
+		size_t valueCount; /**< The count of items in the values array. */
 	} MessageData;
 	
 	/**

--- a/src/CayenneMQTTClient/FP.h	Fri Oct 07 22:41:27 2016 +0000
+++ b/src/CayenneMQTTClient/FP.h	Fri Oct 07 22:44:16 2016 +0000
@@ -20,74 +20,73 @@
 #define FP_H
 
 /** 
- * @class FP
- * @brief API for managing Function Pointers
- * Example using the FP Class with global functions
- * @code
- *  #include "mbed.h"
- *  #include "FP.h"
- *
- *  FP<void,bool>fp;
- *  DigitalOut myled(LED1);
- *
- *  void handler(bool value)
- *  {
- *      myled = value;
- *      return;
- *  }
- *
- *  int main()
- *  {
- *      fp.attach(&handler);
- *
- *      while(1)
- *      {
- *          fp(1);
- *          wait(0.2);
- *          fp(0);
- *          wait(0.2);
- *      }
- *  }
- * @endcode
- */
-
-/** Example using the FP Class with different class member functions
- * @code
- *  #include "mbed.h"
- *  #include "FP.h"
- *
- *  FP<void,bool>fp;
- *  DigitalOut myled(LED4);
- *
- *  class Wrapper
- *  {
- *  public:
- *      Wrapper(){}
- *
- *      void handler(bool value)
- *      {
- *          myled = value;
- *          return;
- *      }
- *  };
- *
- *  int main()
- *  {
- *      Wrapper wrapped;
- *      fp.attach(&wrapped, &Wrapper::handler);
- *
- *      while(1)
- *      {
- *          fp(1);
- *          wait(0.2);
- *          fp(0);
- *          wait(0.2);
- *      }
- *  }
- * @endcode
- */
-
-/** Example using the FP Class with member FP and member function
+* @class FP
+* @brief API for managing Function Pointers
+*
+* Example using the FP Class with global functions
+* @code
+*  #include "mbed.h"
+*  #include "FP.h"
+*
+*  FP<void,bool>fp;
+*  DigitalOut myled(LED1);
+*
+*  void handler(bool value)
+*  {
+*      myled = value;
+*      return;
+*  }
+*
+*  int main()
+*  {
+*      fp.attach(&handler);
+*
+*      while(1)
+*      {
+*          fp(1);
+*          wait(0.2);
+*          fp(0);
+*          wait(0.2);
+*      }
+*  }
+* @endcode
+*
+* Example using the FP Class with different class member functions
+* @code
+*  #include "mbed.h"
+*  #include "FP.h"
+*
+*  FP<void,bool>fp;
+*  DigitalOut myled(LED4);
+*
+*  class Wrapper
+*  {
+*  public:
+*      Wrapper(){}
+*
+*      void handler(bool value)
+*      {
+*          myled = value;
+*          return;
+*      }
+*  };
+*
+*  int main()
+*  {
+*      Wrapper wrapped;
+*      fp.attach(&wrapped, &Wrapper::handler);
+*
+*      while(1)
+*      {
+*          fp(1);
+*          wait(0.2);
+*          fp(0);
+*          wait(0.2);
+*      }
+*  }
+* @endcode
+* 
+* Example using the FP Class with member FP and member function
 * @code
 *  #include "mbed.h"
 *  #include "FP.h"