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 | 306e19cb9ffc452f5759c863ef55b6e9e837f6b1 (patch) | |
| tree | 74bc898f90582f359cdc0aef990e8c3eb99aa44e /examples/test-usart-dma.cpp | |
| parent | 06dace8e01fdf72561a0ee59c409896d79a89e12 (diff) | |
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 'examples/test-usart-dma.cpp')
| -rw-r--r-- | examples/test-usart-dma.cpp | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/examples/test-usart-dma.cpp b/examples/test-usart-dma.cpp index 8fbcccb..10ebe8b 100644 --- a/examples/test-usart-dma.cpp +++ b/examples/test-usart-dma.cpp @@ -1,5 +1,5 @@ /** - * @file test-usart-dma.cpp + * @file examples/test-usart-dma.cpp * @author Marti Bolivar <mbolivar@leaflabs.com> * * Simple test of DMA used with a USART receiver. |