Commit 0f45b9c8 authored by Dean Camera's avatar Dean Camera
Browse files

More spell checking of all source files -- correct missed errors, switch to...

More spell checking of all source files -- correct missed errors, switch to EN-GB spelling dictionary.
parent 2034141a
...@@ -52,7 +52,7 @@ ...@@ -52,7 +52,7 @@
* *
* \section SSec_Options Project Options * \section SSec_Options Project Options
* *
* The following defines can be found in this demo, which can control the demo behavior when defined, or changed in value. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
* *
* <table> * <table>
* <tr> * <tr>
......
...@@ -53,7 +53,7 @@ ...@@ -53,7 +53,7 @@
* *
* \section SSec_Options Project Options * \section SSec_Options Project Options
* *
* The following defines can be found in this demo, which can control the demo behavior when defined, or changed in value. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
* *
* <table> * <table>
* <tr> * <tr>
......
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
* \brief AVR-GCC special function/variable attribute macros. * \brief AVR-GCC special function/variable attribute macros.
* *
* This file contains macros for applying GCC specific attributes to functions and variables to control various * This file contains macros for applying GCC specific attributes to functions and variables to control various
* optimizer and code generation features of the compiler. Attributes may be placed in the function prototype * optimiser 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.
* *
...@@ -115,7 +115,7 @@ ...@@ -115,7 +115,7 @@
/** Forces the compiler to not automatically zero the given global variable on startup, so that the /** Forces the compiler to not automatically zero the given global variable on startup, so that the
* current RAM contents is retained. Under most conditions this value will be random due to the * current RAM contents is retained. Under most conditions this value will be random due to the
* behavior of volatile memory once power is removed, but may be used in some specific circumstances, * behaviour of volatile memory once power is removed, but may be used in some specific circumstances,
* like the passing of values back after a system watchdog reset. * like the passing of values back after a system watchdog reset.
*/ */
#define ATTR_NO_INIT __attribute__ ((section (".noinit"))) #define ATTR_NO_INIT __attribute__ ((section (".noinit")))
......
...@@ -80,7 +80,7 @@ ...@@ -80,7 +80,7 @@
#define MACROE while (0) #define MACROE while (0)
/** Defines a volatile NOP statement which cannot be optimized out by the compiler, and thus can always /** Defines a volatile 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 optimizer * be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimiser
* 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.
* *
* \ingroup Group_Debugging * \ingroup Group_Debugging
...@@ -127,7 +127,7 @@ ...@@ -127,7 +127,7 @@
/** Swaps the byte ordering of a 16-bit value at compile time. Do not use this macro for swapping byte orderings /** Swaps the byte ordering of a 16-bit value at compile time. Do not use this macro for swapping byte orderings
* of dynamic values computed at runtime, use \ref SwapEndian_16() instead. The result of this macro can be used * of dynamic values computed at runtime, use \ref SwapEndian_16() instead. The result of this macro can be used
* inside struct or other variable initializers outside of a function, something that is not possible with the * inside struct or other variable initialisers outside of a function, something that is not possible with the
* inline function variant. * inline function variant.
* *
* \param[in] x 16-bit value whose byte ordering is to be swapped. * \param[in] x 16-bit value whose byte ordering is to be swapped.
...@@ -138,7 +138,7 @@ ...@@ -138,7 +138,7 @@
/** Swaps the byte ordering of a 32-bit value at compile time. Do not use this macro for swapping byte orderings /** Swaps the byte ordering of a 32-bit value at compile time. Do not use this macro for swapping byte orderings
* of dynamic values computed at runtime- use \ref SwapEndian_32() instead. The result of this macro can be used * of dynamic values computed at runtime- use \ref SwapEndian_32() instead. The result of this macro can be used
* inside struct or other variable initializers outside of a function, something that is not possible with the * inside struct or other variable initialisers outside of a function, something that is not possible with the
* inline function variant. * inline function variant.
* *
* \param[in] x 32-bit value whose byte ordering is to be swapped. * \param[in] x 32-bit value whose byte ordering is to be swapped.
......
...@@ -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: */
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC. /** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
* The AVR's SPI driver MUST be initialized before any of the dataflash commands are used. * The AVR'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)
......
...@@ -99,7 +99,7 @@ ...@@ -99,7 +99,7 @@
/* Pseudo-Functions for Doxygen: */ /* Pseudo-Functions for Doxygen: */
#if defined(__DOXYGEN__) #if defined(__DOXYGEN__)
/** Initializes the BUTTONS driver, so that the current button position can be read. This sets the appropriate /** Initialises 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.
......
...@@ -92,7 +92,7 @@ ...@@ -92,7 +92,7 @@
#define DATAFLASH_CHIP_MASK(index) __GET_DATAFLASH_MASK(index) #define DATAFLASH_CHIP_MASK(index) __GET_DATAFLASH_MASK(index)
/* Inline Functions: */ /* Inline Functions: */
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC. /** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
* The AVR's SPI driver MUST be initialized before any of the dataflash commands are used. * The AVR'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);
......
...@@ -85,7 +85,7 @@ ...@@ -85,7 +85,7 @@
#define DATAFLASH_PAGES 8192 #define DATAFLASH_PAGES 8192
/* Inline Functions: */ /* Inline Functions: */
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC. /** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
* The AVR's SPI driver MUST be initialized before any of the dataflash commands are used. * The AVR'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)
......
...@@ -90,7 +90,7 @@ ...@@ -90,7 +90,7 @@
/* Pseudo-Functions for Doxygen: */ /* Pseudo-Functions for Doxygen: */
#if defined(__DOXYGEN__) #if defined(__DOXYGEN__)
/** Initializes the joystick driver so that the joystick position can be read. This sets the appropriate /** Initialises 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);
......
...@@ -58,7 +58,7 @@ ...@@ -58,7 +58,7 @@
* *
* \note To make code as compatible as possible, it is assumed that all boards carry a minimum of four LEDs. If * \note To make code as compatible as possible, it is assumed that all boards carry a minimum of four LEDs. If
* a board contains less than four LEDs, the remaining LED masks are defined to 0 so as to have no effect. * a board contains less than four LEDs, the remaining LED masks are defined to 0 so as to have no effect.
* If other behavior is desired, either alias the remaining LED masks to existing LED masks via the -D * If other behaviour is desired, either alias the remaining LED masks to existing LED masks via the -D
* switch in the project makefile, or alias them to nothing in the makefile to cause compilation errors when * switch in the project makefile, or alias them to nothing in the makefile to cause compilation errors when
* a non-existing LED is referenced in application code. Note that this means that it is possible to make * a non-existing LED is referenced in application code. Note that this means that it is possible to make
* compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers) * compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers)
...@@ -133,7 +133,7 @@ ...@@ -133,7 +133,7 @@
/* Pseudo-Functions for Doxygen: */ /* Pseudo-Functions for Doxygen: */
#if defined(__DOXYGEN__) #if defined(__DOXYGEN__)
/** Initializes the board LED driver so that the LEDs can be controlled. This sets the appropriate port /** Initialises 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);
......
...@@ -85,7 +85,7 @@ ...@@ -85,7 +85,7 @@
#define DATAFLASH_PAGES 8192 #define DATAFLASH_PAGES 8192
/* Inline Functions: */ /* Inline Functions: */
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC. /** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
* The AVR's SPI driver MUST be initialized before any of the dataflash commands are used. * The AVR'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)
......
...@@ -85,7 +85,7 @@ ...@@ -85,7 +85,7 @@
#define DATAFLASH_PAGES 8192 #define DATAFLASH_PAGES 8192
/* Inline Functions: */ /* Inline Functions: */
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC. /** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
* The AVR's SPI driver MUST be initialized before any of the dataflash commands are used. * The AVR'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)
......
...@@ -87,7 +87,7 @@ ...@@ -87,7 +87,7 @@
#define TEMP_MAX_TEMP ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET) #define TEMP_MAX_TEMP ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET)
/* Inline Functions: */ /* Inline Functions: */
/** Initializes the temperature sensor driver, including setting up the appropriate ADC channel. /** Initialises 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
......
...@@ -88,7 +88,7 @@ ...@@ -88,7 +88,7 @@
#define DATAFLASH_PAGES 8192 #define DATAFLASH_PAGES 8192
/* Inline Functions: */ /* Inline Functions: */
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC. /** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
* The AVR's SPI driver MUST be initialized before any of the dataflash commands are used. * The AVR'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)
......
...@@ -91,7 +91,7 @@ ...@@ -91,7 +91,7 @@
#endif #endif
/* Inline Functions: */ /* Inline Functions: */
/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC. /** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
* The AVR's SPI driver MUST be initialized before any of the dataflash commands are used. * The AVR'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)
......
...@@ -350,7 +350,7 @@ ...@@ -350,7 +350,7 @@
return ADC_GetResult(); return ADC_GetResult();
} }
/** Initializes the ADC, ready for conversions. This must be called before any other ADC operations. /** Initialises the ADC, ready for conversions. This must be called before any other ADC operations.
* The "mode" parameter should be a mask comprised of a conversion mode (free running or single) and * The "mode" parameter should be a mask comprised of a conversion mode (free running or single) and
* prescaler masks. * prescaler masks.
* *
......
...@@ -71,7 +71,7 @@ ...@@ -71,7 +71,7 @@
/* Public Interface - May be used in end-application: */ /* Public Interface - May be used in end-application: */
/* Inline Functions: */ /* Inline Functions: */
/** Initializes the TWI hardware into master mode, ready for data transmission and reception. This must be /** Initialises the TWI hardware into master mode, ready for data transmission and reception. This must be
* before any other TWI operations. * before any other TWI operations.
*/ */
static inline void TWI_Init(void) ATTR_ALWAYS_INLINE; static inline void TWI_Init(void) ATTR_ALWAYS_INLINE;
......
...@@ -113,7 +113,7 @@ ...@@ -113,7 +113,7 @@
#define SPI_MODE_MASTER (1 << MSTR) #define SPI_MODE_MASTER (1 << MSTR)
/* Inline Functions: */ /* Inline Functions: */
/** Initializes the SPI subsystem, ready for transfers. Must be called before calling any other /** Initialises the SPI subsystem, ready for transfers. Must be called before calling any other
* SPI routines. * SPI routines.
* *
* \param[in] SPIOptions SPI Options, a mask consisting of one of each of the SPI_SPEED_*, * \param[in] SPIOptions SPI Options, a mask consisting of one of each of the SPI_SPEED_*,
......
...@@ -90,7 +90,7 @@ ...@@ -90,7 +90,7 @@
void Serial_TxString(const char* StringPtr) ATTR_NON_NULL_PTR_ARG(1); void Serial_TxString(const char* StringPtr) ATTR_NON_NULL_PTR_ARG(1);
/* Inline Functions: */ /* Inline Functions: */
/** Initializes the USART, ready for serial data transmission and reception. This initializes the interface to /** Initialises the USART, ready for serial data transmission and reception. This initialises the interface to
* standard 8-bit, no parity, 1 stop bit settings suitable for most applications. * standard 8-bit, no parity, 1 stop bit settings suitable for most applications.
* *
* \param[in] BaudRate Serial baud rate, in bits per second. * \param[in] BaudRate Serial baud rate, in bits per second.
......
...@@ -82,7 +82,7 @@ ...@@ -82,7 +82,7 @@
/* Public Interface - May be used in end-application: */ /* Public Interface - May be used in end-application: */
/* Inline Functions: */ /* Inline Functions: */
/** Initializes the serial stream (and regular USART driver) so that both the stream and regular /** Initialises the serial stream (and regular USART driver) so that both the stream and regular
* USART driver functions can be used. Must be called before any stream or regular USART functions. * USART driver functions can be used. Must be called before any stream or regular USART functions.
* *
* \param[in] BaudRate Baud rate to configure the USART to. * \param[in] BaudRate Baud rate to configure the USART to.
......
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