ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

All comments in the library, bootloaders, demos and projects have now been spell-checked and spelling mistakes/typos corrected.

Browse source
This commit is contained in:
Dean Camera 2009-04-01 13:53:58 +00:00
parent fb3fcb968e
commit 6933f2e1a5
95 changed files with 274 additions and 273 deletions
Download patch file Download diff file Expand all files Collapse all files

18
LUFA/Common/Common.h
View file

@ -31,7 +31,7 @@
/** \file
*
* This file contains macros which are common to all library elements, and which may be useful in user code. It
* also includes other common headees, such as Atomic.h, FunctionAttributes.h and BoardTypes.h.
* also includes other common headers, such as Atomic.h, FunctionAttributes.h and BoardTypes.h.
*/
#ifndef __COMMON_H__
@ -49,27 +49,27 @@
/* Public Interface - May be used in end-application: */
/* Macros: */
/** Macro for encasing other multi-statment macros. This should be used along with an opening brace
/** Macro for encasing other multi-statement macros. This should be used along with an opening brace
* before the start of any multi-statement macro, so that the macros contents as a whole are treated
* as a discreete block and not as a list of seperate statements which may cause problems when used as
* a block (such as inline IF statments).
* as a discrete block and not as a list of separate statements which may cause problems when used as
* a block (such as inline IF statements).
*/
#define MACROS do
/** Macro for encasing other multi-statment macros. This should be used along with a preceeding closing
/** Macro for encasing other multi-statement macros. This should be used along with a preceding closing
* brace at the end of any multi-statement macro, so that the macros contents as a whole are treated
* as a discreete block and not as a list of seperate statements which may cause problems when used as
* a block (such as inline IF statments).
* as a discrete block and not as a list of separate statements which may cause problems when used as
* a block (such as inline IF statements).
*/
#define MACROE while (0)
/** Defines a volatile NOP statment 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
* removes/reorders code to the point where break points cannot reliably be set.
*/
#define JTAG_DEBUG_POINT() asm volatile ("NOP" ::)
/** Defines an explicit JTAG break point in the resulting binary via the ASM BREAK statment. When
/** Defines an explicit JTAG break point in the resulting binary via the ASM BREAK statement. When
* a JTAG is used, this causes the program execution to halt when reached until manually resumed. */
#define JTAG_DEBUG_BREAK() asm volatile ("BREAK" ::)

10
LUFA/Common/FunctionAttributes.h
View file

@ -32,7 +32,7 @@
*
* This file contains macros for applying GCC specific attributes to functions to control various optimizer
* and code generation features of the compiler. Attributes may be placed in the function prototype in any
* order, and multiple attributes can be specified for a single function via a space seperated list.
* order, and multiple attributes can be specified for a single function via a space separated list.
*
* \note Do not include this file directly, rather include the Common.h header file instead to gain this file's
* functionality.
@ -49,11 +49,11 @@
/* Public Interface - May be used in end-application: */
/* Macros: */
/** Indicates to the compiler that the function can not ever return, so that any stack restoring or
* return code may be ommited by the compiler in the resulting binary.
* return code may be omitted by the compiler in the resulting binary.
*/
#define ATTR_NO_RETURN __attribute__ ((noreturn))
/** Places the function in one of the initilization sections, which execute before the main function
/** Places the function in one of the initialization sections, which execute before the main function
* of the application. The init function number can be specified as "x", as an integer. Refer to the
* avr-libc manual for more information on the initialization sections.
*/
@ -65,12 +65,12 @@
#define ATTR_WARN_UNUSED_RESULT __attribute__ ((warn_unused_result))
/** Indicates that the specified parameters of the function are pointers which should never be NULL.
* When applied as a 1-based comma seperated list the compiler will emmit a warning if the specified
* When applied as a 1-based comma separated list the compiler will emit a warning if the specified
* parameters are known at compiler time to be NULL at the point of calling the function.
*/
#define ATTR_NON_NULL_PTR_ARG(...) __attribute__ ((nonnull (__VA_ARGS__)))
/** Removes any preample or postample from the function. When used, the function will not have any
/** Removes any preamble or postamble from the function. When used, the function will not have any
* register or stack saving code. This should be used with caution, and when used the programmer
* is responsible for maintaining stack and register integrity.
*/