Add Doxygen documentation to the completed portions of the PDI programming protocol...

[pub/USBasp.git] / Projects / AVRISP / Lib / PDIProtocol.c

diff --git a/Projects/AVRISP/Lib/PDIProtocol.c b/Projects/AVRISP/Lib/PDIProtocol.c
index af6fbea..24ce26c 100644 (file)
--- a/Projects/AVRISP/Lib/PDIProtocol.c
+++ b/Projects/AVRISP/Lib/PDIProtocol.c
@@ -37,9 +37,12 @@
 #include "PDIProtocol.h"\r
 \r
 #if defined(ENABLE_PDI_PROTOCOL) || defined(__DOXYGEN__)\r
 #include "PDIProtocol.h"\r
 \r
 #if defined(ENABLE_PDI_PROTOCOL) || defined(__DOXYGEN__)\r

-#warning PDI Programming Protocol support is incomplete and not currently suitable for use.\r
+#warning PDI Programming Protocol support is incomplete and not currently suitable for general use.\r

 \r
 \r

+/** Base absolute address for the target's NVM controller */\r

 uint32_t XPROG_Param_NVMBase;\r
 uint32_t XPROG_Param_NVMBase;\r

+\r
+/** Size in bytes of the target's EEPROM page */\r

 uint32_t XPROG_Param_EEPageSize;\r
 \r
 /** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI\r
 uint32_t XPROG_Param_EEPageSize;\r
 \r
 /** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI\r