aboutsummaryrefslogtreecommitdiffstats
path: root/Projects/AVRISP-MKII/Lib/XPROG
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2013-03-18 19:24:55 +0000
committerDean Camera <dean@fourwalledcubicle.com>2013-03-18 19:24:55 +0000
commit03cdb09071c5c9ed9dd0f851a0980d360a4492d0 (patch)
tree26aca239e281055455d88b9d44a8a1c52b97beb1 /Projects/AVRISP-MKII/Lib/XPROG
parent88bcc6fde546f12a31f46b5c8b77631b0c648638 (diff)
downloadlufa-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.tar.gz
lufa-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.tar.bz2
lufa-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.zip
Minor documentation improvements.
Diffstat (limited to 'Projects/AVRISP-MKII/Lib/XPROG')
-rw-r--r--Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c12
-rw-r--r--Projects/AVRISP-MKII/Lib/XPROG/XMEGANVM.c16
2 files changed, 14 insertions, 14 deletions
diff --git a/Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c b/Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
index f2d3a9adf..f28386317 100644
--- a/Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
+++ b/Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
@@ -72,7 +72,7 @@ static void TINYNVM_SendWriteNVMRegister(const uint8_t Address)
/** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read.
*
- * \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
+ * \return Boolean \c true if the NVM controller became ready within the timeout period, \c false otherwise
*/
bool TINYNVM_WaitWhileNVMBusBusy(void)
{
@@ -97,7 +97,7 @@ bool TINYNVM_WaitWhileNVMBusBusy(void)
/** Waits while the target's NVM controller is busy performing an operation, exiting if the
* timeout period expires.
*
- * \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
+ * \return Boolean \c true if the NVM controller became ready within the timeout period, \c false otherwise
*/
bool TINYNVM_WaitWhileNVMControllerBusy(void)
{
@@ -121,7 +121,7 @@ bool TINYNVM_WaitWhileNVMControllerBusy(void)
/** Enables the physical TPI interface on the target and enables access to the internal NVM controller.
*
- * \return Boolean true if the TPI interface was enabled successfully, false otherwise
+ * \return Boolean \c true if the TPI interface was enabled successfully, \c false otherwise
*/
bool TINYNVM_EnableTPI(void)
{
@@ -165,7 +165,7 @@ void TINYNVM_DisableTPI(void)
* \param[out] ReadBuffer Buffer to store read data into
* \param[in] ReadSize Length of the data to read from the device
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean \c true if the command sequence complete successfully
*/
bool TINYNVM_ReadMemory(const uint16_t ReadAddress,
uint8_t* ReadBuffer,
@@ -198,7 +198,7 @@ bool TINYNVM_ReadMemory(const uint16_t ReadAddress,
* \param[in] WriteBuffer Buffer to source data from
* \param[in] WriteLength Total number of bytes to write to the device (must be an integer multiple of 2)
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean \c true if the command sequence complete successfully
*/
bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
uint8_t* WriteBuffer,
@@ -245,7 +245,7 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
* \param[in] EraseCommand NVM erase command to send to the device
* \param[in] Address Address inside the memory space to erase
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean \c true if the command sequence complete successfully
*/
bool TINYNVM_EraseMemory(const uint8_t EraseCommand,
const uint16_t Address)
diff --git a/Projects/AVRISP-MKII/Lib/XPROG/XMEGANVM.c b/Projects/AVRISP-MKII/Lib/XPROG/XMEGANVM.c
index adb9b3ca6..06a4f7222 100644
--- a/Projects/AVRISP-MKII/Lib/XPROG/XMEGANVM.c
+++ b/Projects/AVRISP-MKII/Lib/XPROG/XMEGANVM.c
@@ -67,7 +67,7 @@ static void XMEGANVM_SendNVMRegAddress(const uint8_t Register)
/** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read or CRC
* calculation.
*
- * \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
+ * \return Boolean \c true if the NVM controller became ready within the timeout period, \c false otherwise
*/
bool XMEGANVM_WaitWhileNVMBusBusy(void)
{
@@ -92,7 +92,7 @@ bool XMEGANVM_WaitWhileNVMBusBusy(void)
/** Waits while the target's NVM controller is busy performing an operation, exiting if the
* timeout period expires.
*
- * \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
+ * \return Boolean \c true if the NVM controller became ready within the timeout period, \c false otherwise
*/
bool XMEGANVM_WaitWhileNVMControllerBusy(void)
{
@@ -120,7 +120,7 @@ bool XMEGANVM_WaitWhileNVMControllerBusy(void)
/** Enables the physical PDI interface on the target and enables access to the internal NVM controller.
*
- * \return Boolean true if the PDI interface was enabled successfully, false otherwise
+ * \return Boolean \c true if the PDI interface was enabled successfully, \c false otherwise
*/
bool XMEGANVM_EnablePDI(void)
{
@@ -170,7 +170,7 @@ void XMEGANVM_DisablePDI(void)
* \param[in] CRCCommand NVM CRC command to issue to the target
* \param[out] CRCDest CRC Destination when read from the target
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean \c true if the command sequence complete successfully
*/
bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand,
uint32_t* const CRCDest)
@@ -221,7 +221,7 @@ bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand,
* \param[out] ReadBuffer Buffer to store read data into
* \param[in] ReadSize Number of bytes to read
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean \c true if the command sequence complete successfully
*/
bool XMEGANVM_ReadMemory(const uint32_t ReadAddress,
uint8_t* ReadBuffer,
@@ -258,7 +258,7 @@ bool XMEGANVM_ReadMemory(const uint32_t ReadAddress,
* \param[in] WriteAddress Address to write to within the target's address space
* \param[in] Byte Byte to write to the target
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean \c true if the command sequence complete successfully
*/
bool XMEGANVM_WriteByteMemory(const uint8_t WriteCommand,
const uint32_t WriteAddress,
@@ -291,7 +291,7 @@ bool XMEGANVM_WriteByteMemory(const uint8_t WriteCommand,
* \param[in] WriteBuffer Buffer to source data from
* \param[in] WriteSize Number of bytes to write
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean \c true if the command sequence complete successfully
*/
bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand,
const uint8_t EraseBuffCommand,
@@ -368,7 +368,7 @@ bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand,
* \param[in] EraseCommand NVM erase command to send to the device
* \param[in] Address Address inside the memory space to erase
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean \c true if the command sequence complete successfully
*/
bool XMEGANVM_EraseMemory(const uint8_t EraseCommand,
const uint32_t Address)