X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/2073b96d82433607bd287e3b6529fd0d3cc428cd..30f6d2bfd82995e0fa346b3b4eb33861f6a0fde3:/LUFA/Drivers/Peripheral/Serial.h?ds=inline diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h index f40201de5..7b3659ca0 100644 --- a/LUFA/Drivers/Peripheral/Serial.h +++ b/LUFA/Drivers/Peripheral/Serial.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2010. + Copyright (C) Dean Camera, 2011. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* - Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted @@ -41,11 +41,14 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/Peripheral/Serial.c (Makefile source module name: LUFA_SRC_SERIAL) * - * \section Module Description + * \section Sec_ModDescription Module Description * Hardware serial USART driver. This module provides an easy to use driver for * the setup of and transfer of data over the AVR's USART port. * - * Example Usage: + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. + * * \code * // Initialise the serial USART driver before first use, with 9600 baud (and no double-speed mode) * Serial_Init(9600, false); @@ -136,7 +139,7 @@ /** Indicates whether a character has been received through the USART. * - * \return Boolean true if a character has been received, false otherwise. + * \return Boolean \c true if a character has been received, \c false otherwise. */ static inline bool Serial_IsCharReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Serial_IsCharReceived(void)