NDEF NFC library

Diff: Message.h

Revision:

12:ed4d9b8d1410

Parent:

10:9f34b0cfefe4

Child:

15:01fc5a4b8366

--- a/Message.h	Mon Jan 11 13:04:33 2016 +0000
+++ b/Message.h	Thu Jan 14 07:54:44 2016 +0000
@@ -45,31 +45,31 @@
 namespace NDefLib {
 
 /**
- * class containing a list of {@link Record}
+ * Class containing a list of {@link Record}
  */
 class Message {
 public:
 
 	/**
-	 * add a ndef record to this message
-	 * @param r record to add
+	 * Add a ndef record to this message.
+	 * @param r Record to add
 	 */
 	void addRecord(Record *r) {
 		mRecords.push_back(r);
 	}
 
 	/**
-	 * add all the record in the list to this message
-	 * @param addList list of record to add
+	 * Add all the records in the list to this message.
+	 * @param addList List of records to add.
 	 */
 	void addRecords(const std::vector<Record*> &addList) {
 		mRecords.insert(mRecords.end(), addList.begin(), addList.end());
 	}
 
 	/**
-	 * get the specific record contained by this message, or NULL if isn't a valid index
-	 * @param index record index
-	 * @return if present a record otherwise NULL
+	 * Get the specific record contained by this message, NULL if not a valid index.
+	 * @param index Record index.
+	 * @return a Record object if present, otherwise NULL
 	 */
 	Record* operator[](const uint32_t index){
 		if (index >= mRecords.size())
@@ -78,43 +78,43 @@
 	}
 
 	/**
-	 * get the number of records in this message
-	 * @return number of record in this message
+	 * Get the number of records in this message.
+	 * @return number of records in this message
 	 */
 	uint32_t getNRecords() const {
 		return mRecords.size();
 	}
 
 	/**
-	 * length in byte needed for write this message
-	 * @return number of byte needed for with this message
+	 * Length in bytes needed to write this message.
+	 * @return number of bytes needed to write this message
 	 */
 	uint16_t getByteLength() const;
 
 	/**
-	 * write this message in the buffer
-	 * @par the first 2 byte are the NDEF message length
-	 * @param[out] buffer buffer where write this message
-	 * @return number of bytes wrote
+	 * Write message in the provided buffer
+	 * @par The first 2 bytes contain the NDEF message length.
+	 * @param[out] buffer Buffer the message must be written into.
+	 * @return number of bytes written
 	 */
 	uint16_t write(uint8_t *buffer) const;
 
 	/**
-	 * try to rebuild all the record from a message buffer
-	 * @par I assume that you already read the NDEF length, so the buffer doesn't contain it
-	 * @param buffer buffer containing the message record
-	 * @param bufferLength buffer length
-	 * @param message message where the function will add the read record
+	 * Create a set of records from a raw buffer adding them to a message object.
+	 * @par Message buffer must NOT contain the buffer length in the first two bytes.
+	 * @param buffer Buffer containing the message record.
+	 * @param bufferLength Buffer length.
+	 * @param[in,out] Message message that will contain the new records.
 	 */
 	static void parseMessage(const uint8_t * const buffer,
-			const uint8_t bufferLength, Message *message);
+			const uint16_t bufferLength, Message *message);
 
 	virtual ~Message() {
 	}
 
 private:
 	/**
-	 * list of record contained by this message
+	 * List of records contained by this message.
 	 */
 	std::vector<Record*> mRecords;
 };