Add more doxygen comments

adafruit · Jan 30, 2024 · acda42c · acda42c
1 parent 7a8ed7f
commit acda42c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/Adafruit_PN532.cpp b/Adafruit_PN532.cpp
@@ -1609,7 +1609,7 @@ uint8_t Adafruit_PN532::felica_Polling(uint16_t systemCode, uint8_t requestCode,
    Polling command)
     @param[in]  commandlength   Length of the FeliCa command packet. (e.g. 0x05
    for above Polling command )
-    @param[out] responselength  Length of the FeliCa response packet. (e.g. 0x11
+    @param[out] responseLength  Length of the FeliCa response packet. (e.g. 0x11
    for above Polling command )
     @return                          = 1: Success
                                      = 0: error

diff --git a/Adafruit_PN532.h b/Adafruit_PN532.h
@@ -90,9 +90,9 @@
 #define MIFARE_ULTRALIGHT_CMD_WRITE (0xA2) ///< Write (MiFare Ultralight)
 
 // FeliCa Commands
-#define FELICA_CMD_POLLING (0x00)
-#define FELICA_CMD_READ_WITHOUT_ENCRYPTION (0x06)
-#define FELICA_CMD_WRITE_WITHOUT_ENCRYPTION (0x08)
+#define FELICA_CMD_POLLING (0x00)	   ///< Polling cmd
+#define FELICA_CMD_READ_WITHOUT_ENCRYPTION (0x06)	///< Read without encryption
+#define FELICA_CMD_WRITE_WITHOUT_ENCRYPTION (0x08)	///< Write without encryption
 
 // Prefixes for NDEF Records (to identify record type)
 #define NDEF_URIPREFIX_NONE (0x00)         ///< No prefix
@@ -141,10 +141,10 @@
 #define PN532_GPIO_P35 (5)              ///< GPIO 35
 
 // FeliCa consts
-#define FELICA_READ_MAX_SERVICE_NUM 16
-#define FELICA_READ_MAX_BLOCK_NUM 12 // for typical FeliCa card
-#define FELICA_WRITE_MAX_SERVICE_NUM 16
-#define FELICA_WRITE_MAX_BLOCK_NUM 10 // for typical FeliCa card
+#define FELICA_READ_MAX_SERVICE_NUM 16	///< Maximum number of services code during reading
+#define FELICA_READ_MAX_BLOCK_NUM 12 	///< for typical FeliCa card
+#define FELICA_WRITE_MAX_SERVICE_NUM 16	///< Maximum number of services code during writing
+#define FELICA_WRITE_MAX_BLOCK_NUM 10 	//< for typical FeliCa card
 #define FELICA_REQ_SERVICE_MAX_NODE_NUM 32
 
 /**