Diff: snep.h

Revision:

6:418ee8924317

Parent:

3:4189a10038e6

--- a/snep.h	Thu Nov 21 04:41:47 2013 +0000
+++ b/snep.h	Tue Mar 25 16:00:44 2014 +0000
@@ -13,6 +13,9 @@
 #define SNEP_RESPONSE_SUCCESS	0x81
 #define SNEP_RESPONSE_REJECT	0xFF
 
+/**
+ * The SNEP class
+ */
 class SNEP {
 public:
 	SNEP(PN532Interface &interface) : llcp(interface) {
@@ -20,24 +23,24 @@
 	};
 
 	/**
-    * @brief    write a SNEP packet, the packet should be less than (255 - 2 - 3) bytes
-    * @param    buf     the buffer to contain the packet
-    * @param    len     lenght of the buffer
-    * @param    timeout max time to wait, 0 means no timeout
-    * @return   >0      success
-    *			=0      timeout
-    *           <0      failed
-    */
+     * @brief    write a SNEP packet, the packet should be less than (255 - 2 - 3) bytes
+     * @param    buf     the buffer to contain the packet
+     * @param    len     lenght of the buffer
+     * @param    timeout max time to wait, 0 means no timeout
+     * @return   >0      success
+     *			=0      timeout
+     *           <0      failed
+     */
     int8_t write(const uint8_t *buf, uint8_t len, uint16_t timeout = 0);
 
     /**
-    * @brief    read a SNEP packet, the packet will be less than (255 - 2 - 3) bytes
-    * @param    buf     the buffer to contain the packet
-    * @param    len     lenght of the buffer
-    * @param    timeout max time to wait, 0 means no timeout
-    * @return   >=0     length of the packet 
-    *           <0      failed
-    */
+     * @brief    read a SNEP packet, the packet will be less than (255 - 2 - 3) bytes
+     * @param    buf     the buffer to contain the packet
+     * @param    len     lenght of the buffer
+     * @param    timeout max time to wait, 0 means no timeout
+     * @return   >=0     length of the packet 
+     *           <0      failed
+     */
     int16_t read(uint8_t *buf, uint8_t len, uint16_t timeout = 0);
 
 private: