Commit f01a0541 authored by Dean Camera's avatar Dean Camera
Browse files

Spell check library source code files.

parent 6d2a08f1
...@@ -153,7 +153,7 @@ void TCP_TCPTask(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo, ...@@ -153,7 +153,7 @@ void TCP_TCPTask(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo,
} }
} }
/** Initialises the TCP protocol handler, clearing the port and connection state tables. This must be called before TCP packets are /** Initializes the TCP protocol handler, clearing the port and connection state tables. This must be called before TCP packets are
* processed. * processed.
*/ */
void TCP_Init(void) void TCP_Init(void)
......
...@@ -74,7 +74,7 @@ char PROGMEM HTTPPage[] = ...@@ -74,7 +74,7 @@ char PROGMEM HTTPPage[] =
"</html>"; "</html>";
/** Initialises the Webserver application, opening the appropriate HTTP port in the TCP handler and registering the application /** Initializes the Webserver application, opening the appropriate HTTP port in the TCP handler and registering the application
* callback routine for packets sent to the HTTP protocol port. * callback routine for packets sent to the HTTP protocol port.
*/ */
void Webserver_Init(void) void Webserver_Init(void)
......
...@@ -152,7 +152,7 @@ void TCP_Task(void) ...@@ -152,7 +152,7 @@ void TCP_Task(void)
} }
} }
/** Initialises the TCP protocol handler, clearing the port and connection state tables. This must be called before TCP packets are /** Initializes the TCP protocol handler, clearing the port and connection state tables. This must be called before TCP packets are
* processed. * processed.
*/ */
void TCP_Init(void) void TCP_Init(void)
......
...@@ -74,7 +74,7 @@ char PROGMEM HTTPPage[] = ...@@ -74,7 +74,7 @@ char PROGMEM HTTPPage[] =
"</html>"; "</html>";
/** Initialises the Webserver application, opening the appropriate HTTP port in the TCP handler and registering the application /** Initializes the Webserver application, opening the appropriate HTTP port in the TCP handler and registering the application
* callback routine for packets sent to the HTTP protocol port. * callback routine for packets sent to the HTTP protocol port.
*/ */
void Webserver_Init(void) void Webserver_Init(void)
......
...@@ -142,7 +142,7 @@ void Android_Host_Task(void) ...@@ -142,7 +142,7 @@ void Android_Host_Task(void)
/* Save whether the Android device needs to be mode-switched later on */ /* Save whether the Android device needs to be mode-switched later on */
bool RequiresModeSwitch = (ErrorCode == NonAccessoryModeAndroidDevice); bool RequiresModeSwitch = (ErrorCode == NonAccessoryModeAndroidDevice);
/* Error out if the device is not an Android device or an error ocurred */ /* Error out if the device is not an Android device or an error occurred */
if ((ErrorCode != AccessoryModeAndroidDevice) && !(RequiresModeSwitch)) if ((ErrorCode != AccessoryModeAndroidDevice) && !(RequiresModeSwitch))
{ {
if (ErrorCode == DevControlError) if (ErrorCode == DevControlError)
......
...@@ -65,7 +65,7 @@ const uint8_t CRC8_Table[256] PROGMEM = ...@@ -65,7 +65,7 @@ const uint8_t CRC8_Table[256] PROGMEM =
RFCOMM_Channel_t RFCOMM_Channels[RFCOMM_MAX_OPEN_CHANNELS]; RFCOMM_Channel_t RFCOMM_Channels[RFCOMM_MAX_OPEN_CHANNELS];
/** Initialises the RFCOMM service, ready for new connections from a SDP client. */ /** Initializes the RFCOMM service, ready for new connections from a SDP client. */
void RFCOMM_Initialize(void) void RFCOMM_Initialize(void)
{ {
/* Reset the RFCOMM channel structures, to invalidate any configured RFCOMM channels */ /* Reset the RFCOMM channel structures, to invalidate any configured RFCOMM channels */
......
...@@ -122,7 +122,7 @@ uint8_t RNDIS_SendKeepAlive(void) ...@@ -122,7 +122,7 @@ uint8_t RNDIS_SendKeepAlive(void)
return HOST_SENDCONTROL_Successful; return HOST_SENDCONTROL_Successful;
} }
/** Initialises the attached RNDIS device's RNDIS interface. /** Initializes the attached RNDIS device's RNDIS interface.
* *
* \param[in] HostMaxPacketSize Size of the packet buffer on the host * \param[in] HostMaxPacketSize Size of the packet buffer on the host
* \param[out] DeviceMaxPacketSize Pointer to where the packet buffer size of the device is to be stored * \param[out] DeviceMaxPacketSize Pointer to where the packet buffer size of the device is to be stored
......
...@@ -79,7 +79,7 @@ ...@@ -79,7 +79,7 @@
#define DATAFLASH_PAGES // TODO: Replace with the total number of pages inside one of the Dataflash ICs #define DATAFLASH_PAGES // TODO: Replace with the total number of pages inside one of the Dataflash ICs
/* Inline Functions: */ /* Inline Functions: */
/** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC. /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
* The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used. * The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
*/ */
static inline void Dataflash_Init(void) static inline void Dataflash_Init(void)
......
...@@ -42,7 +42,7 @@ ...@@ -42,7 +42,7 @@
* \brief GCC special function/variable attribute macros. * \brief GCC special function/variable attribute macros.
* *
* This module contains macros for applying GCC specific attributes to functions and variables to control various * This module contains macros for applying GCC specific attributes to functions and variables to control various
* optimiser and code generation features of the compiler. Attributes may be placed in the function prototype * optimizer and code generation features of the compiler. Attributes may be placed in the function prototype
* or variable declaration in any order, and multiple attributes can be specified for a single item via a space * or variable declaration in any order, and multiple attributes can be specified for a single item via a space
* separated list. * separated list.
* *
...@@ -85,13 +85,13 @@ ...@@ -85,13 +85,13 @@
*/ */
#define ATTR_NAKED __attribute__ ((naked)) #define ATTR_NAKED __attribute__ ((naked))
/** Prevents the compiler from considering a specified function for inlining. When applied, the given /** Prevents the compiler from considering a specified function for in-lining. When applied, the given
* function will not be inlined under any circumstances. * function will not be in-lined under any circumstances.
*/ */
#define ATTR_NO_INLINE __attribute__ ((noinline)) #define ATTR_NO_INLINE __attribute__ ((noinline))
/** Forces the compiler to inline the specified function. When applied, the given function will be /** Forces the compiler to inline the specified function. When applied, the given function will be
* inlined under all circumstances. * in-lined under all circumstances.
*/ */
#define ATTR_ALWAYS_INLINE __attribute__ ((always_inline)) #define ATTR_ALWAYS_INLINE __attribute__ ((always_inline))
......
...@@ -163,7 +163,7 @@ ...@@ -163,7 +163,7 @@
#if (ARCH == ARCH_AVR8) || defined(__DOXYGEN__) #if (ARCH == ARCH_AVR8) || defined(__DOXYGEN__)
/** Defines a volatile \c NOP statement which cannot be optimized out by the compiler, and thus can always /** Defines a volatile \c NOP statement which cannot be optimized out by the compiler, and thus can always
* be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimiser * be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimizer
* removes/reorders code to the point where break points cannot reliably be set. * removes/reorders code to the point where break points cannot reliably be set.
* *
* \note This macro is not available for all architectures. * \note This macro is not available for all architectures.
......
...@@ -83,7 +83,7 @@ ...@@ -83,7 +83,7 @@
#define DATAFLASH_PAGES 8192 #define DATAFLASH_PAGES 8192
/* Inline Functions: */ /* Inline Functions: */
/** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC. /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
* The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used. * The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
*/ */
static inline void Dataflash_Init(void) static inline void Dataflash_Init(void)
......
...@@ -83,7 +83,7 @@ ...@@ -83,7 +83,7 @@
#define DATAFLASH_PAGES 8192 #define DATAFLASH_PAGES 8192
/* Inline Functions: */ /* Inline Functions: */
/** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC. /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
* The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used. * The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
*/ */
static inline void Dataflash_Init(void) static inline void Dataflash_Init(void)
......
...@@ -83,7 +83,7 @@ ...@@ -83,7 +83,7 @@
#define DATAFLASH_PAGES 8192 #define DATAFLASH_PAGES 8192
/* Inline Functions: */ /* Inline Functions: */
/** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC. /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
* The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used. * The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
*/ */
static inline void Dataflash_Init(void) static inline void Dataflash_Init(void)
......
...@@ -86,7 +86,7 @@ ...@@ -86,7 +86,7 @@
#define DATAFLASH_PAGES 8192 #define DATAFLASH_PAGES 8192
/* Inline Functions: */ /* Inline Functions: */
/** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC. /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
* The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used. * The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
*/ */
static inline void Dataflash_Init(void) static inline void Dataflash_Init(void)
......
...@@ -89,7 +89,7 @@ ...@@ -89,7 +89,7 @@
#endif #endif
/* Inline Functions: */ /* Inline Functions: */
/** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC. /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
* The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used. * The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
*/ */
static inline void Dataflash_Init(void) static inline void Dataflash_Init(void)
......
...@@ -66,7 +66,7 @@ ...@@ -66,7 +66,7 @@
* application. * application.
* *
* \code * \code
* // Initialise the button driver before first use * // Initialize the button driver before first use
* Buttons_Init(); * Buttons_Init();
* *
* printf("Waiting for button press...\r\n"); * printf("Waiting for button press...\r\n");
...@@ -131,7 +131,7 @@ ...@@ -131,7 +131,7 @@
/* Pseudo-Functions for Doxygen: */ /* Pseudo-Functions for Doxygen: */
#if defined(__DOXYGEN__) #if defined(__DOXYGEN__)
/** Initialises the BUTTONS driver, so that the current button position can be read. This sets the appropriate /** Initializes the BUTTONS driver, so that the current button position can be read. This sets the appropriate
* I/O pins to an inputs with pull-ups enabled. * I/O pins to an inputs with pull-ups enabled.
* *
* This must be called before any Button driver functions are used. * This must be called before any Button driver functions are used.
......
...@@ -66,7 +66,7 @@ ...@@ -66,7 +66,7 @@
* application. * application.
* *
* \code * \code
* // Initialise the SPI and board Dataflash drivers before first use * // Initialize the SPI and board Dataflash drivers before first use
* SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING | * SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING |
* SPI_SAMPLE_TRAILING | SPI_MODE_MASTER); * SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
* Dataflash_Init(); * Dataflash_Init();
...@@ -146,7 +146,7 @@ ...@@ -146,7 +146,7 @@
#define DATAFLASH_CHIP_MASK(index) __GET_DATAFLASH_MASK(index) #define DATAFLASH_CHIP_MASK(index) __GET_DATAFLASH_MASK(index)
/* Inline Functions: */ /* Inline Functions: */
/** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC. /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
* *
* \note The microcontroller's SPI driver must be initialized before any of the dataflash commands are used. * \note The microcontroller's SPI driver must be initialized before any of the dataflash commands are used.
*/ */
......
...@@ -65,7 +65,7 @@ ...@@ -65,7 +65,7 @@
* application. * application.
* *
* \code * \code
* // Initialise the board Joystick driver before first use * // Initialize the board Joystick driver before first use
* Joystick_Init(); * Joystick_Init();
* *
* printf("Waiting for joystick movement...\r\n"); * printf("Waiting for joystick movement...\r\n");
...@@ -119,7 +119,7 @@ ...@@ -119,7 +119,7 @@
/* Pseudo-Functions for Doxygen: */ /* Pseudo-Functions for Doxygen: */
#if defined(__DOXYGEN__) #if defined(__DOXYGEN__)
/** Initialises the joystick driver so that the joystick position can be read. This sets the appropriate /** Initializes the joystick driver so that the joystick position can be read. This sets the appropriate
* I/O pins to inputs with their pull-ups enabled. * I/O pins to inputs with their pull-ups enabled.
*/ */
static inline void Joystick_Init(void); static inline void Joystick_Init(void);
......
...@@ -74,7 +74,7 @@ ...@@ -74,7 +74,7 @@
* application. * application.
* *
* \code * \code
* // Initialise the board LED driver before first use * // Initialize the board LED driver before first use
* LEDs_Init(); * LEDs_Init();
* *
* // Turn on each of the four LEDs in turn * // Turn on each of the four LEDs in turn
...@@ -187,7 +187,7 @@ ...@@ -187,7 +187,7 @@
/* Pseudo-Functions for Doxygen: */ /* Pseudo-Functions for Doxygen: */
#if defined(__DOXYGEN__) #if defined(__DOXYGEN__)
/** Initialises the board LED driver so that the LEDs can be controlled. This sets the appropriate port /** Initializes the board LED driver so that the LEDs can be controlled. This sets the appropriate port
* I/O pins as outputs, and sets the LEDs to default to off. * I/O pins as outputs, and sets the LEDs to default to off.
*/ */
static inline void LEDs_Init(void); static inline void LEDs_Init(void);
......
...@@ -53,7 +53,7 @@ ...@@ -53,7 +53,7 @@
* application. * application.
* *
* \code * \code
* // Initialise the ADC and board temperature sensor drivers before first use * // Initialize the ADC and board temperature sensor drivers before first use
* ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128); * ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128);
* Temperature_Init(); * Temperature_Init();
* *
...@@ -102,7 +102,7 @@ ...@@ -102,7 +102,7 @@
#define TEMP_MAX_TEMP ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET_DEGREES) #define TEMP_MAX_TEMP ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET_DEGREES)
/* Inline Functions: */ /* Inline Functions: */
/** Initialises the temperature sensor driver, including setting up the appropriate ADC channel. /** Initializes the temperature sensor driver, including setting up the appropriate ADC channel.
* This must be called before any other temperature sensor routines. * This must be called before any other temperature sensor routines.
* *
* \pre The ADC itself (not the ADC channel) must be configured separately before calling the * \pre The ADC itself (not the ADC channel) must be configured separately before calling the
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment