diff options
| author | Marti Bolivar <mbolivar@leaflabs.com> | 2012-05-08 16:22:41 -0400 |
|---|---|---|
| committer | Marti Bolivar <mbolivar@leaflabs.com> | 2012-05-08 16:22:41 -0400 |
| commit | b5c11895b59fbfdc6dda9d26e02df053f8035ff2 (patch) | |
| tree | 74bc898f90582f359cdc0aef990e8c3eb99aa44e /libmaple/usb | |
| parent | 4af77d8a765061c23ff517a807852060892838ab (diff) | |
| download | librambutan-b5c11895b59fbfdc6dda9d26e02df053f8035ff2.tar.gz librambutan-b5c11895b59fbfdc6dda9d26e02df053f8035ff2.zip | |
Fix a bunch of Doxygen file-level comments.
Fix @file in many places. Also fix up the descriptions where it's
appropriate. This standardizes the @file formatting across the library
to explicitly include any parent directories up to the repository
root.
Besides being nice, this will hopefully let us manage Doxygen's XML
output so as to make extracting series-specific pieces via Breathe in
the leaflabs-docs repo possible.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
Diffstat (limited to 'libmaple/usb')
| -rw-r--r-- | libmaple/usb/usb.c | 4 | ||||
| -rw-r--r-- | libmaple/usb/usb_cdcacm.c | 8 |
2 files changed, 8 insertions, 4 deletions
diff --git a/libmaple/usb/usb.c b/libmaple/usb/usb.c index 6f23848..0130bab 100644 --- a/libmaple/usb/usb.c +++ b/libmaple/usb/usb.c @@ -25,8 +25,10 @@ *****************************************************************************/ /** - * @file usb.c + * @file libmaple/usb/usb.c * @brief USB support. + * + * This is a mess. What we need almost amounts to a ground-up rewrite. */ #include <libmaple/usb.h> diff --git a/libmaple/usb/usb_cdcacm.c b/libmaple/usb/usb_cdcacm.c index 07d2bc8..6ef4806 100644 --- a/libmaple/usb/usb_cdcacm.c +++ b/libmaple/usb/usb_cdcacm.c @@ -25,10 +25,12 @@ *****************************************************************************/ /** - * @file usb_cdcacm.c + * @file libmaple/usb/usb_cdcacm.c + * @brief USB CDC ACM (a.k.a. virtual serial terminal, VCOM). * - * @brief USB CDC ACM (a.k.a. virtual serial terminal, VCOM) state and - * routines. + * FIXME: this works on the STM32F1 USB peripherals, and probably no + * place else. Nonportable bits really need to be factored out, and + * the result made cleaner. */ #include <libmaple/usb_cdcacm.h> |