Minor fixups to the documentation and preprocessor tokens.

15 years ago · 53eca61d02
parent f979fd36be
commit 53eca61d02
8 changed files with 19 additions and 18 deletions
--- a/Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.h
+++ b/Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.h
@ -33,8 +33,8 @@
 *  Header file for DataflashManager.c.
 */
 
-#ifndef _DATAFLASH_MANAGER_H
-#define _DATAFLASH_MANAGER_H
+#ifndef _DATAFLASH_MANAGER_H_
+#define _DATAFLASH_MANAGER_H_

 	/* Includes: */
 		#include <avr/io.h>
--- a/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.h
+++ b/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.h
@ -33,8 +33,8 @@
 *  Header file for DataflashManager.c.
 */
 
-#ifndef _DATAFLASH_MANAGER_H
-#define _DATAFLASH_MANAGER_H
+#ifndef _DATAFLASH_MANAGER_H_
+#define _DATAFLASH_MANAGER_H_

 	/* Includes: */
 		#include <avr/io.h>
--- a/Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.h
+++ b/Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.h
@ -33,8 +33,8 @@
 *  Header file for DataflashManager.c.
 */
 
-#ifndef _DATAFLASH_MANAGER_H
-#define _DATAFLASH_MANAGER_H
+#ifndef _DATAFLASH_MANAGER_H_
+#define _DATAFLASH_MANAGER_H_

 	/* Includes: */
 		#include <avr/io.h>
--- a/Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
+++ b/Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
@ -143,9 +143,9 @@ bool TINYNVM_ReadMemory(const uint16_t ReadAddress, uint8_t* ReadBuffer, uint16_

 /** Writes word addressed memory to the target's memory spaces.
 *
- *  \param[in]  WriteAddress  Start address to write to within the target's address space
- *  \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)
+ *  \param[in] WriteAddress  Start address to write to within the target's address space
+ *  \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
 */
@ -189,7 +189,8 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress, uint8_t* WriteBuffer, uint

 /** Erases the target's memory space.
 *
- *  \param[in] Address  Address inside the memory space to erase
+ *  \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
 */
--- a/Projects/Incomplete/StandaloneProgrammer/Lib/DataflashManager.h
+++ b/Projects/Incomplete/StandaloneProgrammer/Lib/DataflashManager.h
@ -33,8 +33,8 @@
 *  Header file for DataflashManager.c.
 */
 
-#ifndef _DATAFLASH_MANAGER_H
-#define _DATAFLASH_MANAGER_H
+#ifndef _DATAFLASH_MANAGER_H_
+#define _DATAFLASH_MANAGER_H_

 	/* Includes: */
 		#include <avr/io.h>
--- a/Projects/TemperatureDataLogger/Lib/DataflashManager.h
+++ b/Projects/TemperatureDataLogger/Lib/DataflashManager.h
@ -33,8 +33,8 @@
 *  Header file for DataflashManager.c.
 */
 
-#ifndef _DATAFLASH_MANAGER_H
-#define _DATAFLASH_MANAGER_H
+#ifndef _DATAFLASH_MANAGER_H_
+#define _DATAFLASH_MANAGER_H_

 	/* Includes: */
 		#include <avr/io.h>
--- a/Projects/Webserver/Lib/DataflashManager.h
+++ b/Projects/Webserver/Lib/DataflashManager.h
@ -33,8 +33,8 @@
 *  Header file for DataflashManager.c.
 */
 
-#ifndef _DATAFLASH_MANAGER_H
-#define _DATAFLASH_MANAGER_H
+#ifndef _DATAFLASH_MANAGER_H_
+#define _DATAFLASH_MANAGER_H_

 	/* Includes: */
 		#include <avr/io.h>
--- a/Projects/Webserver/Lib/uIPManagement.h
+++ b/Projects/Webserver/Lib/uIPManagement.h
@ -33,8 +33,8 @@
 *  Header file for uIPManagement.c.
 */

-#ifndef _UIPMANAGEMENT_H_
-#define _UIPMANAGEMENT_H_
+#ifndef _UIP_MANAGEMENT_H_
+#define _UIP_MANAGEMENT_H_

 	/* Includes: */
 		#include <LUFA/Drivers/USB/Class/RNDIS.h>