Documentation-related fixes.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@8674 35acf78f-673a-0410-8e92-d51de3d6d3f4
This commit is contained in:
Giovanni Di Sirio 2016-01-03 11:04:07 +00:00
parent a02c36fc65
commit 25673ac6de
1 changed files with 23 additions and 7 deletions

View File

@ -325,7 +325,7 @@
* @brief Serial buffers size.
* @details Configuration parameter, you can change the depth of the queue
* buffers depending on the requirements of your application.
* @note The default is 64 bytes for both the transmission and receive
* @note The default is 16 bytes for both the transmission and receive
* buffers.
*/
#if !defined(SERIAL_BUFFERS_SIZE) || defined(__DOXYGEN__)
@ -344,12 +344,20 @@
* @brief Serial over USB buffers size.
* @details Configuration parameter, the buffer size must be a multiple of
* the USB data endpoint maximum packet size.
* @note The default is 64 bytes for both the transmission and receive
* @note The default is 256 bytes for both the transmission and receive
* buffers.
*/
#if !defined(SERIAL_USB_BUFFERS_SIZE) || defined(__DOXYGEN__)
#define SERIAL_USB_BUFFERS_SIZE 256
#endif
/**
* @brief Serial over USB number of buffers.
* @note The default is 2 buffers.
*/
#if !defined(SERIAL_USB_BUFFERS_NUMBER) || defined(__DOXYGEN__)
#define SERIAL_USB_BUFFERS_NUMBER 2
#endif
/** @} */
/*===========================================================================*/
@ -377,7 +385,10 @@
/** @} */
/*===========================================================================*/
/* UART driver related settings. */
/**
* @name UART driver related setting
* @{
*/
/*===========================================================================*/
/**
@ -385,7 +396,7 @@
* @note Disabling this option saves both code and data space.
*/
#if !defined(UART_USE_WAIT) || defined(__DOXYGEN__)
#define UART_USE_WAIT FALSE
#define UART_USE_WAIT TRUE
#endif
/**
@ -393,11 +404,15 @@
* @note Disabling this option saves both code and data space.
*/
#if !defined(UART_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
#define UART_USE_MUTUAL_EXCLUSION FALSE
#define UART_USE_MUTUAL_EXCLUSION TRUE
#endif
/** @} */
/*===========================================================================*/
/* USB driver related settings. */
/**
* @name USB driver related setting
* @{
*/
/*===========================================================================*/
/**
@ -405,8 +420,9 @@
* @note Disabling this option saves both code and data space.
*/
#if !defined(USB_USE_WAIT) || defined(__DOXYGEN__)
#define USB_USE_WAIT FALSE
#define USB_USE_WAIT TRUE
#endif
/** @} */
#endif /* _HALCONF_H_ */