diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2010-12-26 14:25:34 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2010-12-26 14:25:34 +0000 |
| commit | 2073b96d82433607bd287e3b6529fd0d3cc428cd (patch) | |
| tree | 680767a0fba855e26799e392a59d4b0b6d8be4df /LUFA/Common/Common.h | |
| parent | 39ac72f2d12a9c62b2e876de4eee6c34a864ff74 (diff) | |
| download | lufa-2073b96d82433607bd287e3b6529fd0d3cc428cd.tar.gz lufa-2073b96d82433607bd287e3b6529fd0d3cc428cd.tar.bz2 lufa-2073b96d82433607bd287e3b6529fd0d3cc428cd.zip | |
Added basic driver example use code to the library documentation.
Made the USARTStream global public and documented in the SerialStream module, allowing for the serial USART stream to be accessed via its handle rather than via the implicit stdout and stdin streams.
Diffstat (limited to 'LUFA/Common/Common.h')
| -rw-r--r-- | LUFA/Common/Common.h | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h index f2e5e313d..1e9e9663f 100644 --- a/LUFA/Common/Common.h +++ b/LUFA/Common/Common.h @@ -96,9 +96,11 @@ /** Macro for testing condition "x" and breaking via JTAG_DEBUG_BREAK() if the condition is false. * + * \param[in] Condition Condition that will be evaluated, + * * \ingroup Group_Debugging */ - #define JTAG_DEBUG_ASSERT(x) MACROS{ if (!(x)) { JTAG_DEBUG_BREAK(); } }MACROE + #define JTAG_DEBUG_ASSERT(Condition) MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE /** Macro for testing condition "x" and writing debug data to the stdout stream if false. The stdout stream * must be pre-initialized before this macro is run and linked to an output device, such as the AVR's USART @@ -106,11 +108,13 @@ * * The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {x} failed." * + * \param[in] Condition Condition that will be evaluated, + * * \ingroup Group_Debugging */ - #define STDOUT_ASSERT(x) MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: " \ - "Assertion \"%s\" failed.\r\n"), \ - __FILE__, __func__, __LINE__, #x); } }MACROE + #define STDOUT_ASSERT(Condition) MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: " \ + "Assertion \"%s\" failed.\r\n"), \ + __FILE__, __func__, __LINE__, #x); } }MACROE /** Forces GCC to use pointer indirection (via the AVR's pointer register pairs) when accessing the given * struct pointer. In some cases GCC will emit non-optimal assembly code when accessing a structure through |