aboutsummaryrefslogtreecommitdiffstats
path: root/libmaple/include/libmaple/bkp.h
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2012-05-08 16:22:41 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2012-05-08 16:22:41 -0400
commitb5c11895b59fbfdc6dda9d26e02df053f8035ff2 (patch)
tree74bc898f90582f359cdc0aef990e8c3eb99aa44e /libmaple/include/libmaple/bkp.h
parent4af77d8a765061c23ff517a807852060892838ab (diff)
downloadlibrambutan-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/include/libmaple/bkp.h')
-rw-r--r--libmaple/include/libmaple/bkp.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/libmaple/include/libmaple/bkp.h b/libmaple/include/libmaple/bkp.h
index edc1013..bb63a2f 100644
--- a/libmaple/include/libmaple/bkp.h
+++ b/libmaple/include/libmaple/bkp.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file bkp.h
+ * @file libmaple/include/libmaple/bkp.h
* @brief Backup register support (STM32F1 only).
*/