Revision 51:cce9990f102a, committed 2015-05-22

Comitter:

Alex Young

Date:

Fri May 22 15:41:46 2015 +0200

Parent:

50:f581d5428ea6

Child:

52:e2197b38c029

Commit message:

Clarify documentation for user responsibility to deallocate message data

Changed in this revision

--- a/xbus/xbusparser.h	Fri May 22 15:40:27 2015 +0200
+++ b/xbus/xbusparser.h	Fri May 22 15:41:46 2015 +0200
@@ -37,8 +37,9 @@
 	 * \returns Pointer to buffer to use for message reception, or NULL if
 	 * a buffer cannot be allocated.
 	 *
-	 * \note It is the resposibility of the callback to deallocate the buffer
-	 * once it is done with processing the message.
+	 * \note It is the resposibility of the user to deallocate the message
+	 * data buffers pointed to by XbusMessage structures passed to the
+	 * handleMessage() callback function.
 	 */
 	void* (*allocateBuffer)(size_t bufSize);
 
@@ -50,6 +51,10 @@
 
 	/*!
 	 * \brief Handle a received message.
+	 *
+	 * \note If the passed XbusMessage structure has a non-null data pointer
+	 * then it is the responsibility of the user to free this once handling
+	 * of the message is complete.
 	 */
 	void (*handleMessage)(struct XbusMessage const* message);
 };