aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/include/serial_usb.h
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2011-08-23 13:36:25 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2011-08-23 13:36:25 +0000
commit718dc5084f7719f91eaacfc99e8c7de654eb2ad8 (patch)
tree14b0f47f04f720f251828ed87fbf008b0331e91a /os/hal/include/serial_usb.h
parentc9be79def630f153b0b2d28e905939c15743f989 (diff)
downloadChibiOS-718dc5084f7719f91eaacfc99e8c7de654eb2ad8.tar.gz
ChibiOS-718dc5084f7719f91eaacfc99e8c7de654eb2ad8.tar.bz2
ChibiOS-718dc5084f7719f91eaacfc99e8c7de654eb2ad8.zip
HAL documentation improvements.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3252 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/include/serial_usb.h')
-rw-r--r--os/hal/include/serial_usb.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/os/hal/include/serial_usb.h b/os/hal/include/serial_usb.h
index 8e518238d..09be9b708 100644
--- a/os/hal/include/serial_usb.h
+++ b/os/hal/include/serial_usb.h
@@ -40,6 +40,10 @@
/*===========================================================================*/
/**
+ * @name SERIAL_USB configuration options
+ * @{
+ */
+/**
* @brief Serial over USB buffers size.
* @details Configuration parameter, the buffer size must be a multiple of
* the USB data endpoint maximum packet size.
@@ -49,6 +53,7 @@
#if !defined(SERIAL_USB_BUFFERS_SIZE) || defined(__DOXYGEN__)
#define SERIAL_USB_BUFFERS_SIZE 64
#endif
+/** @} */
/*===========================================================================*/
/* Derived constants and error checks. */
@@ -119,6 +124,8 @@ typedef struct {
_base_asynchronous_channel_methods
/**
+ * @extends BaseAsynchronousChannelVMT
+ *
* @brief @p SerialDriver virtual methods table.
*/
struct SerialUSBDriverVMT {