Diff: CR95HF.h

Revision:

2:c7006765c441

Parent:

1:549e63ac990c

Child:

3:12c871b2412d

--- a/CR95HF.h	Thu Aug 30 11:43:43 2018 +0000
+++ b/CR95HF.h	Fri Aug 31 06:33:12 2018 +0000
@@ -21,6 +21,7 @@
 *   nfcChip.ConfigManagerTagHunting();
 * }
 *
+* @endcode
 */
 class CR95HF
 {
@@ -30,11 +31,30 @@
         */
         CR95HF(PinName tx, PinName rx);
         ~CR95HF();
+        
+        /**
+        * @brief Init the device
+        */
         uint8_t Init();
+        
+        /**
+        * @brief search the ISO/IEC 15693 tag and get UID
+        */
         uint8_t ConfigManagerTagHunting();
     
     private:
+        /**
+        * @brief the serial class 
+        */
         Serial  nfcDevice;
+        /**
+        * @brief sends the commands over uart
+        * @param cmd buffer with commands
+        * @param len length of the buffer
+        */
         void    nfcWrite(uint8_t cmd[], uint8_t len);
+        /**
+        * @brief callback for uart rx
+        */
         void    rxCallbackNFC();
 };
\ No newline at end of file