diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2010-06-17 08:15:58 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2010-06-17 08:15:58 +0000 |
| commit | deed746d3716d59153e04860c646bfb7b82ca820 (patch) | |
| tree | 3d427b7168cdc7312d0f29a75ca7b2b8d604eaea /LUFA/Common | |
| parent | 69dc32c5f01e8640c1bdf83df3a2a7699ea54560 (diff) | |
| download | lufa-deed746d3716d59153e04860c646bfb7b82ca820.tar.gz lufa-deed746d3716d59153e04860c646bfb7b82ca820.tar.bz2 lufa-deed746d3716d59153e04860c646bfb7b82ca820.zip | |
Renamed SERIAL_STREAM_ASSERT() macro to STDOUT_ASSERT().
Minor tweaks to the library documentation.
Diffstat (limited to 'LUFA/Common')
| -rw-r--r-- | LUFA/Common/Attributes.h | 8 | ||||
| -rw-r--r-- | LUFA/Common/Common.h | 24 |
2 files changed, 16 insertions, 16 deletions
diff --git a/LUFA/Common/Attributes.h b/LUFA/Common/Attributes.h index 01938dc8f..220017a29 100644 --- a/LUFA/Common/Attributes.h +++ b/LUFA/Common/Attributes.h @@ -124,15 +124,15 @@ /** Places the function in one of the initialization sections, which execute before the main function * of the application. Refer to the avr-libc manual for more information on the initialization sections. * - * \param[in] x Initialization section number where the function should be placed + * \param[in] SectionIndex Initialization section number where the function should be placed. */ - #define ATTR_INIT_SECTION(x) __attribute__ ((naked, section (".init" #x ))) + #define ATTR_INIT_SECTION(SectionIndex) __attribute__ ((naked, section (".init" #SectionIndex ))) /** Marks a function as an alias for another function. * - * \param[in] x Name of the function which the given function name should alias + * \param[in] Func Name of the function which the given function name should alias. */ - #define ATTR_ALIAS(x) __attribute__ ((alias( #x ))) + #define ATTR_ALIAS(Func) __attribute__ ((alias( #Func ))) #endif /** @} */ diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h index 76307d7e9..fa9a10f3c 100644 --- a/LUFA/Common/Common.h +++ b/LUFA/Common/Common.h @@ -99,17 +99,17 @@ */ #define JTAG_DEBUG_ASSERT(x) MACROS{ if (!(x)) { JTAG_DEBUG_BREAK(); } }MACROE - /** Macro for testing condition "x" and writing debug data to the serial stream if false. As a - * prerequisite for this macro, the serial stream should be configured via the Peripheral/SerialStream driver. + /** 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 + * peripheral. * - * The serial output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion - * {x} failed." + * The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {x} failed." * * \ingroup Group_Debugging */ - #define SERIAL_STREAM_ASSERT(x) MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: " \ - "Assertion \"%s\" failed.\r\n"), \ - __FILE__, __func__, __LINE__, #x); } \ + #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 /* Inline Functions: */ @@ -118,7 +118,7 @@ * * \ingroup Group_BitManip * - * \param[in] Byte Byte of data whose bits are to be reversed + * \param[in] Byte Byte of data whose bits are to be reversed. */ static inline uint8_t BitReverse(uint8_t Byte) ATTR_WARN_UNUSED_RESULT ATTR_CONST; static inline uint8_t BitReverse(uint8_t Byte) @@ -134,7 +134,7 @@ * * \ingroup Group_BitManip * - * \param[in] Word Word of data whose bytes are to be swapped + * \param[in] Word Word of data whose bytes are to be swapped. */ static inline uint16_t SwapEndian_16(uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST; static inline uint16_t SwapEndian_16(uint16_t Word) @@ -146,7 +146,7 @@ * * \ingroup Group_BitManip * - * \param[in] DWord Double word of data whose bytes are to be swapped + * \param[in] DWord Double word of data whose bytes are to be swapped. */ static inline uint32_t SwapEndian_32(uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST; static inline uint32_t SwapEndian_32(uint32_t DWord) @@ -161,8 +161,8 @@ * * \ingroup Group_BitManip * - * \param[in,out] Data Pointer to a number containing an even number of bytes to be reversed - * \param[in] Bytes Length of the data in bytes + * \param[in,out] Data Pointer to a number containing an even number of bytes to be reversed. + * \param[in] Bytes Length of the data in bytes. */ static inline void SwapEndian_n(void* Data, uint8_t Bytes); static inline void SwapEndian_n(void* Data, uint8_t Bytes) |