From 2073b96d82433607bd287e3b6529fd0d3cc428cd Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 26 Dec 2010 14:25:34 +0000 Subject: 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. --- LUFA/Common/Common.h | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'LUFA/Common') 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 @@ -95,10 +95,12 @@ #define JTAG_DEBUG_BREAK() __asm__ __volatile__ ("BREAK" ::) /** 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 -- cgit v1.2.3