aboutsummaryrefslogtreecommitdiffstats
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
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>
-rw-r--r--examples/test-usart-dma.cpp2
-rw-r--r--libmaple/dac.c2
-rw-r--r--libmaple/exti.c2
-rw-r--r--libmaple/gpio.c2
-rw-r--r--libmaple/i2c.c2
-rw-r--r--libmaple/include/libmaple/adc.h2
-rw-r--r--libmaple/include/libmaple/bitband.h2
-rw-r--r--libmaple/include/libmaple/bkp.h2
-rw-r--r--libmaple/include/libmaple/dac.h2
-rw-r--r--libmaple/include/libmaple/delay.h2
-rw-r--r--libmaple/include/libmaple/exti.h2
-rw-r--r--libmaple/include/libmaple/fsmc.h2
-rw-r--r--libmaple/include/libmaple/gpio.h2
-rw-r--r--libmaple/include/libmaple/i2c.h2
-rw-r--r--libmaple/include/libmaple/iwdg.h2
-rw-r--r--libmaple/include/libmaple/libmaple.h2
-rw-r--r--libmaple/include/libmaple/libmaple_types.h2
-rw-r--r--libmaple/include/libmaple/nvic.h2
-rw-r--r--libmaple/include/libmaple/pwr.h4
-rw-r--r--libmaple/include/libmaple/rcc.h2
-rw-r--r--libmaple/include/libmaple/scb.h2
-rw-r--r--libmaple/include/libmaple/spi.h2
-rw-r--r--libmaple/include/libmaple/systick.h3
-rw-r--r--libmaple/include/libmaple/timer.h2
-rw-r--r--libmaple/include/libmaple/usart.h2
-rw-r--r--libmaple/include/libmaple/usb_cdcacm.h2
-rw-r--r--libmaple/include/libmaple/util.h2
-rw-r--r--libmaple/iwdg.c2
-rw-r--r--libmaple/nvic.c2
-rw-r--r--libmaple/pwr.c2
-rw-r--r--libmaple/stm32f1/adc.c4
-rw-r--r--libmaple/stm32f1/bkp.c4
-rw-r--r--libmaple/stm32f1/fsmc.c2
-rw-r--r--libmaple/stm32f1/gpio.c2
-rw-r--r--libmaple/stm32f1/include/series/adc.h2
-rw-r--r--libmaple/stm32f1/include/series/flash.h2
-rw-r--r--libmaple/stm32f1/include/series/gpio.h8
-rw-r--r--libmaple/stm32f1/include/series/pwr.h2
-rw-r--r--libmaple/stm32f1/include/series/rcc.h4
-rw-r--r--libmaple/stm32f1/include/series/stm32.h2
-rw-r--r--libmaple/stm32f1/include/series/timer.h4
-rw-r--r--libmaple/stm32f1/include/series/usart.h4
-rw-r--r--libmaple/stm32f1/rcc.c2
-rw-r--r--libmaple/stm32f1/spi.c2
-rw-r--r--libmaple/stm32f1/timer.c2
-rw-r--r--libmaple/stm32f1/usart.c2
-rw-r--r--libmaple/stm32f2/adc.c4
-rw-r--r--libmaple/stm32f2/fsmc.c2
-rw-r--r--libmaple/stm32f2/gpio.c2
-rw-r--r--libmaple/stm32f2/include/series/adc.h4
-rw-r--r--libmaple/stm32f2/include/series/flash.h2
-rw-r--r--libmaple/stm32f2/include/series/gpio.h4
-rw-r--r--libmaple/stm32f2/include/series/pwr.h2
-rw-r--r--libmaple/stm32f2/include/series/rcc.h2
-rw-r--r--libmaple/stm32f2/include/series/stm32.h2
-rw-r--r--libmaple/stm32f2/include/series/timer.h4
-rw-r--r--libmaple/stm32f2/include/series/usart.h4
-rw-r--r--libmaple/stm32f2/rcc.c2
-rw-r--r--libmaple/stm32f2/timer.c2
-rw-r--r--libmaple/stm32f2/usart.c2
-rw-r--r--libmaple/syscalls.c8
-rw-r--r--libmaple/systick.c4
-rw-r--r--libmaple/usart.c4
-rw-r--r--libmaple/usb/usb.c4
-rw-r--r--libmaple/usb/usb_cdcacm.c8
-rw-r--r--libmaple/util.c2
-rw-r--r--wirish/HardwareSerial.cpp2
-rw-r--r--wirish/boards.cpp2
-rw-r--r--wirish/ext_interrupts.cpp5
-rw-r--r--wirish/include/wirish/HardwareSPI.h2
-rw-r--r--wirish/include/wirish/HardwareSerial.h2
-rw-r--r--wirish/include/wirish/boards.h4
-rw-r--r--wirish/include/wirish/ext_interrupts.h5
-rw-r--r--wirish/include/wirish/io.h5
-rw-r--r--wirish/include/wirish/pwm.h5
-rw-r--r--wirish/include/wirish/wirish_debug.h2
-rw-r--r--wirish/include/wirish/wirish_math.h4
-rw-r--r--wirish/include/wirish/wirish_time.h2
-rw-r--r--wirish/include/wirish/wirish_types.h2
79 files changed, 112 insertions, 109 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.
diff --git a/libmaple/dac.c b/libmaple/dac.c
index efcba15..f630ac0 100644
--- a/libmaple/dac.c
+++ b/libmaple/dac.c
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file dac.c
+ * @file libmaple/dac.c
* @brief Digital to analog converter support.
*/
diff --git a/libmaple/exti.c b/libmaple/exti.c
index 00e0df2..248c4b6 100644
--- a/libmaple/exti.c
+++ b/libmaple/exti.c
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file exti.c
+ * @file libmaple/exti.c
* @brief External interrupt control routines
*/
diff --git a/libmaple/gpio.c b/libmaple/gpio.c
index 64b2d54..898007a 100644
--- a/libmaple/gpio.c
+++ b/libmaple/gpio.c
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file gpio.c
+ * @file libmaple/gpio.c
* @brief Generic STM32 GPIO support.
*/
diff --git a/libmaple/i2c.c b/libmaple/i2c.c
index ae44532..3eca22a 100644
--- a/libmaple/i2c.c
+++ b/libmaple/i2c.c
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file i2c.c
+ * @file libmaple/i2c.c
* @brief Inter-Integrated Circuit (I2C) support.
*
* Currently, only master mode is supported.
diff --git a/libmaple/include/libmaple/adc.h b/libmaple/include/libmaple/adc.h
index 3cd3eb2..8d2f398 100644
--- a/libmaple/include/libmaple/adc.h
+++ b/libmaple/include/libmaple/adc.h
@@ -26,7 +26,7 @@
*****************************************************************************/
/**
- * @file libmaple/adc.h
+ * @file libmaple/include/libmaple/adc.h
* @author Marti Bolivar <mbolivar@leaflabs.com>,
* Perry Hung <perry@leaflabs.com>
* @brief Analog-to-Digital Conversion (ADC) header.
diff --git a/libmaple/include/libmaple/bitband.h b/libmaple/include/libmaple/bitband.h
index 607e4eb..0980311 100644
--- a/libmaple/include/libmaple/bitband.h
+++ b/libmaple/include/libmaple/bitband.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file bitband.h
+ * @file libmaple/include/libmaple/bitband.h
*
* @brief Bit-banding utility functions
*/
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).
*/
diff --git a/libmaple/include/libmaple/dac.h b/libmaple/include/libmaple/dac.h
index 9bd74b4..047f874 100644
--- a/libmaple/include/libmaple/dac.h
+++ b/libmaple/include/libmaple/dac.h
@@ -26,7 +26,7 @@
*****************************************************************************/
/**
- * @file libmaple/dac.h
+ * @file libmaple/include/libmaple/dac.h
* @brief Digital to analog converter support.
*/
diff --git a/libmaple/include/libmaple/delay.h b/libmaple/include/libmaple/delay.h
index f79655d..472a208 100644
--- a/libmaple/include/libmaple/delay.h
+++ b/libmaple/include/libmaple/delay.h
@@ -26,7 +26,7 @@
*****************************************************************************/
/**
- * @file delay.h
+ * @file libmaple/include/libmaple/delay.h
* @brief Delay implementation
*/
diff --git a/libmaple/include/libmaple/exti.h b/libmaple/include/libmaple/exti.h
index 0a763d7..d7bfe51 100644
--- a/libmaple/include/libmaple/exti.h
+++ b/libmaple/include/libmaple/exti.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file exti.h
+ * @file libmaple/include/libmaple/exti.h
* @brief External interrupt control prototypes and defines
*/
diff --git a/libmaple/include/libmaple/fsmc.h b/libmaple/include/libmaple/fsmc.h
index df211b2..01a6a3b 100644
--- a/libmaple/include/libmaple/fsmc.h
+++ b/libmaple/include/libmaple/fsmc.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file fsmc.h
+ * @file libmaple/include/libmaple/fsmc.h
* @brief Flexible static memory controller support.
*/
diff --git a/libmaple/include/libmaple/gpio.h b/libmaple/include/libmaple/gpio.h
index 609320f..f7773c0 100644
--- a/libmaple/include/libmaple/gpio.h
+++ b/libmaple/include/libmaple/gpio.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file gpio.h
+ * @file libmaple/include/libmaple/gpio.h
* @brief General Purpose I/O (GPIO) interace.
*/
diff --git a/libmaple/include/libmaple/i2c.h b/libmaple/include/libmaple/i2c.h
index 8a1485e..ffd0cfb 100644
--- a/libmaple/include/libmaple/i2c.h
+++ b/libmaple/include/libmaple/i2c.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file i2c.h
+ * @file libmaple/include/libmaple/i2c.h
* @brief Inter-Integrated Circuit (I2C) peripheral support
*/
diff --git a/libmaple/include/libmaple/iwdg.h b/libmaple/include/libmaple/iwdg.h
index 80202d2..0aef8fd 100644
--- a/libmaple/include/libmaple/iwdg.h
+++ b/libmaple/include/libmaple/iwdg.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file libmaple/iwdg.h
+ * @file libmaple/include/libmaple/iwdg.h
* @author Michael Hope, Marti Bolivar <mbolivar@leaflabs.com>
* @brief Independent watchdog support.
*
diff --git a/libmaple/include/libmaple/libmaple.h b/libmaple/include/libmaple/libmaple.h
index 60b23ed..f1a595e 100644
--- a/libmaple/include/libmaple/libmaple.h
+++ b/libmaple/include/libmaple/libmaple.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file libmaple.h
+ * @file libmaple/include/libmaple/libmaple.h
* @brief General include file for libmaple
*/
diff --git a/libmaple/include/libmaple/libmaple_types.h b/libmaple/include/libmaple/libmaple_types.h
index 0a83795..0c22792 100644
--- a/libmaple/include/libmaple/libmaple_types.h
+++ b/libmaple/include/libmaple/libmaple_types.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file libmaple_types.h
+ * @file libmaple/include/libmaple/libmaple_types.h
*
* @brief libmaple's types, and operations on types.
*/
diff --git a/libmaple/include/libmaple/nvic.h b/libmaple/include/libmaple/nvic.h
index 1a1a4ed..86ac1cb 100644
--- a/libmaple/include/libmaple/nvic.h
+++ b/libmaple/include/libmaple/nvic.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file nvic.h
+ * @file libmaple/include/libmaple/nvic.h
* @brief Nested vectored interrupt controller support.
*
* Basic usage:
diff --git a/libmaple/include/libmaple/pwr.h b/libmaple/include/libmaple/pwr.h
index 2611587..e4b5b0d 100644
--- a/libmaple/include/libmaple/pwr.h
+++ b/libmaple/include/libmaple/pwr.h
@@ -25,8 +25,8 @@
*****************************************************************************/
/**
- * @file pwr.h
- * @brief Power control (PWR) defines.
+ * @file libmaple/include/libmaple/pwr.h
+ * @brief Power control (PWR).
*/
#ifndef _LIBMAPLE_PWR_H_
diff --git a/libmaple/include/libmaple/rcc.h b/libmaple/include/libmaple/rcc.h
index b04f016..7c23f1b 100644
--- a/libmaple/include/libmaple/rcc.h
+++ b/libmaple/include/libmaple/rcc.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file libmaple/rcc.h
+ * @file libmaple/include/libmaple/rcc.h
* @brief Reset and Clock Control (RCC) interface.
*/
diff --git a/libmaple/include/libmaple/scb.h b/libmaple/include/libmaple/scb.h
index 9c4ee15..1c7c5d7 100644
--- a/libmaple/include/libmaple/scb.h
+++ b/libmaple/include/libmaple/scb.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file scb.h
+ * @file libmaple/include/libmaple/scb.h
* @brief System control block header
*/
diff --git a/libmaple/include/libmaple/spi.h b/libmaple/include/libmaple/spi.h
index 5b045a9..3805b2e 100644
--- a/libmaple/include/libmaple/spi.h
+++ b/libmaple/include/libmaple/spi.h
@@ -26,7 +26,7 @@
*****************************************************************************/
/**
- * @file libmaple/spi.h
+ * @file libmaple/include/libmaple/spi.h
* @author Marti Bolivar <mbolivar@leaflabs.com>
* @brief Serial Peripheral Interface (SPI) and Integrated
* Interchip Sound (I2S) peripheral support.
diff --git a/libmaple/include/libmaple/systick.h b/libmaple/include/libmaple/systick.h
index 1731c85..551f800 100644
--- a/libmaple/include/libmaple/systick.h
+++ b/libmaple/include/libmaple/systick.h
@@ -25,8 +25,7 @@
*****************************************************************************/
/**
- * @file systick.h
- *
+ * @file libmaple/include/libmaple/systick.h
* @brief System timer definitions
*/
diff --git a/libmaple/include/libmaple/timer.h b/libmaple/include/libmaple/timer.h
index 0a34066..887b7eb 100644
--- a/libmaple/include/libmaple/timer.h
+++ b/libmaple/include/libmaple/timer.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file libmaple/timer.h
+ * @file libmaple/include/libmaple/timer.h
* @author Marti Bolivar <mbolivar@leaflabs.com>
* @brief Timer interface.
*/
diff --git a/libmaple/include/libmaple/usart.h b/libmaple/include/libmaple/usart.h
index 42f9576..ad7eb51 100644
--- a/libmaple/include/libmaple/usart.h
+++ b/libmaple/include/libmaple/usart.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file usart.h
+ * @file libmaple/include/libmaple/usart.h
* @author Marti Bolivar <mbolivar@leaflabs.com>,
* Perry Hung <perry@leaflabs.com>
* @brief USART definitions and prototypes
diff --git a/libmaple/include/libmaple/usb_cdcacm.h b/libmaple/include/libmaple/usb_cdcacm.h
index 2dbcbea..9d70758 100644
--- a/libmaple/include/libmaple/usb_cdcacm.h
+++ b/libmaple/include/libmaple/usb_cdcacm.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file usb_cdcacm.h
+ * @file libmaple/include/libmaple/usb_cdcacm.h
* @brief USB CDC ACM (virtual serial terminal) support
*/
diff --git a/libmaple/include/libmaple/util.h b/libmaple/include/libmaple/util.h
index 78bc03d..60ca0d3 100644
--- a/libmaple/include/libmaple/util.h
+++ b/libmaple/include/libmaple/util.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file util.h
+ * @file libmaple/include/libmaple/util.h
* @brief Miscellaneous utility macros and procedures.
*/
diff --git a/libmaple/iwdg.c b/libmaple/iwdg.c
index 6dd77fc..2456235 100644
--- a/libmaple/iwdg.c
+++ b/libmaple/iwdg.c
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file iwdg.c
+ * @file libmaple/iwdg.c
* @brief Independent watchdog (IWDG) support
*/
diff --git a/libmaple/nvic.c b/libmaple/nvic.c
index e3f79a3..fe7c7bc 100644
--- a/libmaple/nvic.c
+++ b/libmaple/nvic.c
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file nvic.c
+ * @file libmaple/nvic.c
* @brief Nested vector interrupt controller support.
*/
diff --git a/libmaple/pwr.c b/libmaple/pwr.c
index f934269..3cf170f 100644
--- a/libmaple/pwr.c
+++ b/libmaple/pwr.c
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file pwr.c
+ * @file libmaple/pwr.c
* @brief Power control (PWR) support.
*/
diff --git a/libmaple/stm32f1/adc.c b/libmaple/stm32f1/adc.c
index 794c5c8..facc6bd 100644
--- a/libmaple/stm32f1/adc.c
+++ b/libmaple/stm32f1/adc.c
@@ -26,10 +26,10 @@
*****************************************************************************/
/**
- * @file libmaple/stm32f1/include/series/adc.c
+ * @file libmaple/stm32f1/adc.c
* @author Marti Bolivar <mbolivar@leaflabs.com>,
* Perry Hung <perry@leaflabs.com>
- * @brief STM32F1-specific ADC support.
+ * @brief STM32F1 ADC support.
*/
#include <libmaple/adc.h>
diff --git a/libmaple/stm32f1/bkp.c b/libmaple/stm32f1/bkp.c
index 62783e7..f435ff1 100644
--- a/libmaple/stm32f1/bkp.c
+++ b/libmaple/stm32f1/bkp.c
@@ -25,8 +25,8 @@
*****************************************************************************/
/**
- * @file bkp.c
- * @brief Backup register support.
+ * @file libmaple/stm32f1/bkp.c
+ * @brief STM32F1 Backup register support.
*/
#include <libmaple/bkp.h>
diff --git a/libmaple/stm32f1/fsmc.c b/libmaple/stm32f1/fsmc.c
index 8e01b5e..210f0be 100644
--- a/libmaple/stm32f1/fsmc.c
+++ b/libmaple/stm32f1/fsmc.c
@@ -26,7 +26,7 @@
*****************************************************************************/
/**
- * @file stm32f1/fsmc.c
+ * @file libmaple/stm32f1/fsmc.c
* @author Marti Bolivar <mbolivar@leaflabs.com>,
* Bryan Newbold <bnewbold@robocracy.org>
* @brief STM32F1 FSMC support.
diff --git a/libmaple/stm32f1/gpio.c b/libmaple/stm32f1/gpio.c
index 01a4028..2cbe299 100644
--- a/libmaple/stm32f1/gpio.c
+++ b/libmaple/stm32f1/gpio.c
@@ -26,7 +26,7 @@
/**
* @file libmaple/stm32f1/gpio.c
- * @brief GPIO support for STM32F1 line.
+ * @brief STM32F1 GPIO support.
*/
#include <libmaple/gpio.h>
diff --git a/libmaple/stm32f1/include/series/adc.h b/libmaple/stm32f1/include/series/adc.h
index 007641a..774c97c 100644
--- a/libmaple/stm32f1/include/series/adc.h
+++ b/libmaple/stm32f1/include/series/adc.h
@@ -26,7 +26,7 @@
*****************************************************************************/
/**
- * @file stm32f1/include/series/adc.h
+ * @file libmaple/stm32f1/include/series/adc.h
* @author Marti Bolivar <mbolivar@leaflabs.com>,
* Perry Hung <perry@leaflabs.com>
* @brief STM32F1 ADC header.
diff --git a/libmaple/stm32f1/include/series/flash.h b/libmaple/stm32f1/include/series/flash.h
index 5603176..0c70986 100644
--- a/libmaple/stm32f1/include/series/flash.h
+++ b/libmaple/stm32f1/include/series/flash.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file libmaple/stm32f1/flash.h
+ * @file libmaple/stm32f1/include/series/flash.h
* @brief STM32F1 Flash header.
*
* Provides register map, base pointer, and register bit definitions
diff --git a/libmaple/stm32f1/include/series/gpio.h b/libmaple/stm32f1/include/series/gpio.h
index c10244d..1f209fe 100644
--- a/libmaple/stm32f1/include/series/gpio.h
+++ b/libmaple/stm32f1/include/series/gpio.h
@@ -26,9 +26,11 @@
*****************************************************************************/
/**
- * @file libmaple/stm32f1/gpio.h
- * @brief General purpose I/O (GPIO) and Alternate Function I/O
- * (AFIO) prototypes, defines, and inlined access functions.
+ * @file libmaple/stm32f1/include/series/gpio.h
+ * @brief STM32F1 GPIO support.
+ *
+ * General purpose I/O (GPIO) and Alternate Function I/O (AFIO)
+ * prototypes, defines, and support functions.
*/
#ifndef _LIBMAPLE_STM32F1_GPIO_H_
diff --git a/libmaple/stm32f1/include/series/pwr.h b/libmaple/stm32f1/include/series/pwr.h
index d13ffa7..e143a8c 100644
--- a/libmaple/stm32f1/include/series/pwr.h
+++ b/libmaple/stm32f1/include/series/pwr.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file stm32f1/pwr.h
+ * @file libmaple/stm32f1/include/series/pwr.h
* @author Marti Bolivar <mbolivar@leaflabs.com>
* @brief STM32F1 Power control (PWR) support.
*/
diff --git a/libmaple/stm32f1/include/series/rcc.h b/libmaple/stm32f1/include/series/rcc.h
index f60b07b..3e7f7c6 100644
--- a/libmaple/stm32f1/include/series/rcc.h
+++ b/libmaple/stm32f1/include/series/rcc.h
@@ -26,8 +26,8 @@
*****************************************************************************/
/**
- * @file libmaple/stm32f1/rcc.h
- * @brief STM32F1 reset and clock control (RCC) header.
+ * @file libmaple/stm32f1/include/series/rcc.h
+ * @brief STM32F1 reset and clock control (RCC) support.
*/
#ifndef _LIBMAPLE_STM32F1_RCC_H_
diff --git a/libmaple/stm32f1/include/series/stm32.h b/libmaple/stm32f1/include/series/stm32.h
index 999abab..e6d3b19 100644
--- a/libmaple/stm32f1/include/series/stm32.h
+++ b/libmaple/stm32f1/include/series/stm32.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file libmaple/stm32f1/stm32.h
+ * @file libmaple/stm32f1/include/series/stm32.h
* @brief STM32F1 chip- and series-specific definitions.
*/
diff --git a/libmaple/stm32f1/include/series/timer.h b/libmaple/stm32f1/include/series/timer.h
index 2551f70..8a64ffa 100644
--- a/libmaple/stm32f1/include/series/timer.h
+++ b/libmaple/stm32f1/include/series/timer.h
@@ -25,9 +25,9 @@
*****************************************************************************/
/**
- * @file stm32f1/include/series/timer.h
+ * @file libmaple/stm32f1/include/series/timer.h
* @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F1 timer sub-header.
+ * @brief STM32F1 timer support.
*/
#ifndef _LIBMAPLE_STM32F1_TIMER_H_
diff --git a/libmaple/stm32f1/include/series/usart.h b/libmaple/stm32f1/include/series/usart.h
index 93a7728..d12a3e2 100644
--- a/libmaple/stm32f1/include/series/usart.h
+++ b/libmaple/stm32f1/include/series/usart.h
@@ -25,9 +25,9 @@
*****************************************************************************/
/**
- * @file libmaple/stm32f1/usart.h
+ * @file libmaple/stm32f1/include/series/usart.h
* @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F1 USART header.
+ * @brief STM32F1 USART support.
*/
#ifndef _LIBMAPLE_STM32F1_USART_H_
diff --git a/libmaple/stm32f1/rcc.c b/libmaple/stm32f1/rcc.c
index aeedf66..ca81755 100644
--- a/libmaple/stm32f1/rcc.c
+++ b/libmaple/stm32f1/rcc.c
@@ -27,7 +27,7 @@
/**
* @file libmaple/stm32f1/rcc.c
- * @brief STM32F1 RCC routines.
+ * @brief STM32F1 RCC.
*/
#include <libmaple/rcc.h>
diff --git a/libmaple/stm32f1/spi.c b/libmaple/stm32f1/spi.c
index 45ff354..8b6e495 100644
--- a/libmaple/stm32f1/spi.c
+++ b/libmaple/stm32f1/spi.c
@@ -28,7 +28,7 @@
/**
* @file libmaple/stm32f1/spi.c
* @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F1 SPI/I2S support.
+ * @brief STM32F1 SPI/I2S.
*/
#include <libmaple/spi.h>
diff --git a/libmaple/stm32f1/timer.c b/libmaple/stm32f1/timer.c
index 899abbc..002b9d6 100644
--- a/libmaple/stm32f1/timer.c
+++ b/libmaple/stm32f1/timer.c
@@ -27,7 +27,7 @@
/**
* @file libmaple/stm32f1/timer.c
* @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F1 timer support.
+ * @brief STM32F1 timer.
*/
/* Notes:
diff --git a/libmaple/stm32f1/usart.c b/libmaple/stm32f1/usart.c
index ee68082..eed420e 100644
--- a/libmaple/stm32f1/usart.c
+++ b/libmaple/stm32f1/usart.c
@@ -29,7 +29,7 @@
* @file libmaple/stm32f1/usart.c
* @author Marti Bolivar <mbolivar@leaflabs.com>,
* Perry Hung <perry@leaflabs.com>
- * @brief STM32F1 USART support.
+ * @brief STM32F1 USART.
*/
#include <libmaple/usart.h>
diff --git a/libmaple/stm32f2/adc.c b/libmaple/stm32f2/adc.c
index a4c227e..0380736 100644
--- a/libmaple/stm32f2/adc.c
+++ b/libmaple/stm32f2/adc.c
@@ -25,8 +25,8 @@
*****************************************************************************/
/**
- * @file libmaple/stm32f2/include/series/adc.c
- * @brief STM32F2 ADC header.
+ * @file libmaple/stm32f2/adc.c
+ * @brief STM32F2 ADC.
*/
#include <libmaple/adc.h>
diff --git a/libmaple/stm32f2/fsmc.c b/libmaple/stm32f2/fsmc.c
index 9b23eea..7f49cd8 100644
--- a/libmaple/stm32f2/fsmc.c
+++ b/libmaple/stm32f2/fsmc.c
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file stm32f2/fsmc.c
+ * @file libmaple/stm32f2/fsmc.c
* @author Marti Bolivar <mbolivar@leaflabs.com>,
* @brief STM32F2 FSMC support.
*/
diff --git a/libmaple/stm32f2/gpio.c b/libmaple/stm32f2/gpio.c
index e441fbc..7479922 100644
--- a/libmaple/stm32f2/gpio.c
+++ b/libmaple/stm32f2/gpio.c
@@ -26,7 +26,7 @@
/**
* @file libmaple/stm32f2/gpio.c
- * @brief GPIO support for STM32F2 line.
+ * @brief STM32F2 GPIO.
*/
#include <libmaple/gpio.h>
diff --git a/libmaple/stm32f2/include/series/adc.h b/libmaple/stm32f2/include/series/adc.h
index 4f0cd6b..714179c 100644
--- a/libmaple/stm32f2/include/series/adc.h
+++ b/libmaple/stm32f2/include/series/adc.h
@@ -25,9 +25,9 @@
*****************************************************************************/
/**
- * @file stm32f2/include/series/adc.h
+ * @file libmaple/stm32f2/include/series/adc.h
* @author Marti Bolivar <mbolivar@leaflabs.com>,
- * @brief STM32F2 ADC header.
+ * @brief STM32F2 ADC support.
*/
#ifndef _LIBMAPLE_STM32F2_ADC_H_
diff --git a/libmaple/stm32f2/include/series/flash.h b/libmaple/stm32f2/include/series/flash.h
index f48eea3..cfc6e6b 100644
--- a/libmaple/stm32f2/include/series/flash.h
+++ b/libmaple/stm32f2/include/series/flash.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file libmaple/stm32f2/flash.h
+ * @file libmaple/stm32f2/include/series/flash.h
* @brief STM32F2 Flash header.
*
* Provides register map, base pointer, and register bit definitions
diff --git a/libmaple/stm32f2/include/series/gpio.h b/libmaple/stm32f2/include/series/gpio.h
index 40c7292..9687247 100644
--- a/libmaple/stm32f2/include/series/gpio.h
+++ b/libmaple/stm32f2/include/series/gpio.h
@@ -25,8 +25,8 @@
*****************************************************************************/
/**
- * @file libmaple/stm32f2/gpio.h
- * @brief STM32F2 General Purpose I/O (GPIO) header.
+ * @file libmaple/stm32f2/include/series/gpio.h
+ * @brief STM32F2 GPIO support.
*/
#ifndef _LIBMAPLE_STM32F2_GPIO_H_
diff --git a/libmaple/stm32f2/include/series/pwr.h b/libmaple/stm32f2/include/series/pwr.h
index dec2d76..96353a4 100644
--- a/libmaple/stm32f2/include/series/pwr.h
+++ b/libmaple/stm32f2/include/series/pwr.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file stm32f2/pwr.h
+ * @file libmaple/stm32f2/include/series/pwr.h
* @author Marti Bolivar <mbolivar@leaflabs.com>
* @brief STM32F2 Power control (PWR) support.
*/
diff --git a/libmaple/stm32f2/include/series/rcc.h b/libmaple/stm32f2/include/series/rcc.h
index d797ba9..9c3fdd5 100644
--- a/libmaple/stm32f2/include/series/rcc.h
+++ b/libmaple/stm32f2/include/series/rcc.h
@@ -26,7 +26,7 @@
/**
* @file libmaple/stm32f2/include/series/rcc.h
- * @brief STM32F2 reset and clock control (RCC) header.
+ * @brief STM32F2 reset and clock control (RCC) support.
*/
/*
diff --git a/libmaple/stm32f2/include/series/stm32.h b/libmaple/stm32f2/include/series/stm32.h
index 5ab4c56..9e88a70 100644
--- a/libmaple/stm32f2/include/series/stm32.h
+++ b/libmaple/stm32f2/include/series/stm32.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file libmaple/stm32f2/stm32.h
+ * @file libmaple/stm32f2/include/series/stm32.h
* @brief STM32F2 chip- and series-specific definitions.
*/
diff --git a/libmaple/stm32f2/include/series/timer.h b/libmaple/stm32f2/include/series/timer.h
index cf7cc15..0d959d0 100644
--- a/libmaple/stm32f2/include/series/timer.h
+++ b/libmaple/stm32f2/include/series/timer.h
@@ -25,9 +25,9 @@
*****************************************************************************/
/**
- * @file stm32f2/include/series/timer.h
+ * @file libmaple/stm32f2/include/series/timer.h
* @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F2 timer sub-header.
+ * @brief STM32F2 timer support.
*/
#ifndef _LIBMAPLE_STM32F2_TIMER_H_
diff --git a/libmaple/stm32f2/include/series/usart.h b/libmaple/stm32f2/include/series/usart.h
index 9b18b9c..805a2b2 100644
--- a/libmaple/stm32f2/include/series/usart.h
+++ b/libmaple/stm32f2/include/series/usart.h
@@ -25,9 +25,9 @@
*****************************************************************************/
/**
- * @file libmaple/stm32f2/usart.h
+ * @file libmaple/stm32f2/include/series/usart.h
* @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F2 USART header.
+ * @brief STM32F2 USART support.
*/
#ifndef _LIBMAPLE_STM32F2_USART_H_
diff --git a/libmaple/stm32f2/rcc.c b/libmaple/stm32f2/rcc.c
index 8a91f30..a13e56d 100644
--- a/libmaple/stm32f2/rcc.c
+++ b/libmaple/stm32f2/rcc.c
@@ -26,7 +26,7 @@
/**
* @file libmaple/stm32f2/rcc.c
- * @brief STM32F2 RCC routines.
+ * @brief STM32F2 RCC.
*/
#include <libmaple/rcc.h>
diff --git a/libmaple/stm32f2/timer.c b/libmaple/stm32f2/timer.c
index eed7810..3f9a8d2 100644
--- a/libmaple/stm32f2/timer.c
+++ b/libmaple/stm32f2/timer.c
@@ -27,7 +27,7 @@
/**
* @file libmaple/stm32f2/timer.c
* @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F2 timer support.
+ * @brief STM32F2 timers.
*/
#include <libmaple/timer.h>
diff --git a/libmaple/stm32f2/usart.c b/libmaple/stm32f2/usart.c
index 364558c..e4fc9b1 100644
--- a/libmaple/stm32f2/usart.c
+++ b/libmaple/stm32f2/usart.c
@@ -27,7 +27,7 @@
/**
* @file libmaple/stm32f2/usart.c
* @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F2 USART support.
+ * @brief STM32F2 USART.
*/
#include <libmaple/usart.h>
diff --git a/libmaple/syscalls.c b/libmaple/syscalls.c
index 86fd8e6..30a63bf 100644
--- a/libmaple/syscalls.c
+++ b/libmaple/syscalls.c
@@ -25,9 +25,11 @@
*****************************************************************************/
/**
- * @file syscalls.c
- * @brief Low level system routines used by Newlib for basic I/O and
- * memory allocation.
+ * @file libmaple/syscalls.c
+ * @brief newlib stubs
+ *
+ * Low level system routines used by Newlib for basic I/O and memory
+ * allocation.
*/
#include <libmaple/libmaple.h>
diff --git a/libmaple/systick.c b/libmaple/systick.c
index c6e3cbd..80c0c47 100644
--- a/libmaple/systick.c
+++ b/libmaple/systick.c
@@ -25,8 +25,8 @@
*****************************************************************************/
/**
- * @file systick.c
- * @brief System timer interrupt handler and initialization routines
+ * @file libmaple/systick.c
+ * @brief System timer (SysTick).
*/
#include <libmaple/systick.h>
diff --git a/libmaple/usart.c b/libmaple/usart.c
index 1070aa2..253cf9f 100644
--- a/libmaple/usart.c
+++ b/libmaple/usart.c
@@ -25,10 +25,10 @@
*****************************************************************************/
/**
- * @file usart.c
+ * @file libmaple/usart.c
* @author Marti Bolivar <mbolivar@leaflabs.com>,
* Perry Hung <perry@leaflabs.com>
- * @brief USART control routines
+ * @brief Portable USART routines
*/
#include <libmaple/usart.h>
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>
diff --git a/libmaple/util.c b/libmaple/util.c
index 96050a1..ff100fe 100644
--- a/libmaple/util.c
+++ b/libmaple/util.c
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file util.c
+ * @file libmaple/util.c
* @brief Utility procedures for debugging, mostly an error LED fade
* and messages dumped over a UART for failed asserts.
*/
diff --git a/wirish/HardwareSerial.cpp b/wirish/HardwareSerial.cpp
index a9eb763..0f12e72 100644
--- a/wirish/HardwareSerial.cpp
+++ b/wirish/HardwareSerial.cpp
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file HardwareSerial.cpp
+ * @file wirish/HardwareSerial.cpp
* @brief Wirish serial port implementation.
*/
diff --git a/wirish/boards.cpp b/wirish/boards.cpp
index 54807d3..51ff50e 100644
--- a/wirish/boards.cpp
+++ b/wirish/boards.cpp
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file boards.cpp
+ * @file wirish/boards.cpp
* @brief Generic board routines.
*
* This file is mostly interesting for the init() function, which
diff --git a/wirish/ext_interrupts.cpp b/wirish/ext_interrupts.cpp
index 8f8c768..a4a27c2 100644
--- a/wirish/ext_interrupts.cpp
+++ b/wirish/ext_interrupts.cpp
@@ -25,9 +25,8 @@
*****************************************************************************/
/**
- * @file ext_interrupts.c
- *
- * @brief Wiring-like interface for external interrupts
+ * @file wirish/ext_interrupts.c
+ * @brief Wiring-like interface for external interrupts
*/
#include <wirish/ext_interrupts.h>
diff --git a/wirish/include/wirish/HardwareSPI.h b/wirish/include/wirish/HardwareSPI.h
index ad95191..89cf166 100644
--- a/wirish/include/wirish/HardwareSPI.h
+++ b/wirish/include/wirish/HardwareSPI.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file HardwareSPI.h
+ * @file wirish/include/wirish/HardwareSPI.h
* @brief High-level SPI interface
*
* This is a "bare essentials" polling driver for now.
diff --git a/wirish/include/wirish/HardwareSerial.h b/wirish/include/wirish/HardwareSerial.h
index c25fd6e..1eaacb6 100644
--- a/wirish/include/wirish/HardwareSerial.h
+++ b/wirish/include/wirish/HardwareSerial.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file HardwareSerial.h
+ * @file wirish/include/wirish/HardwareSerial.h
* @brief Wirish serial port interface.
*/
diff --git a/wirish/include/wirish/boards.h b/wirish/include/wirish/boards.h
index c762542..3c2740a 100644
--- a/wirish/include/wirish/boards.h
+++ b/wirish/include/wirish/boards.h
@@ -25,10 +25,10 @@
*****************************************************************************/
/**
- * @file boards.h
+ * @file wirish/include/wirish/boards.h
* @author Bryan Newbold <bnewbold@leaflabs.com>,
* Marti Bolivar <mbolivar@leaflabs.com>
- * @brief Board-specific pin information.
+ * @brief init() and board-specific pin information.
*/
#ifndef _WIRISH_BOARDS_H_
diff --git a/wirish/include/wirish/ext_interrupts.h b/wirish/include/wirish/ext_interrupts.h
index 617e43d..03b8e97 100644
--- a/wirish/include/wirish/ext_interrupts.h
+++ b/wirish/include/wirish/ext_interrupts.h
@@ -25,9 +25,8 @@
*****************************************************************************/
/**
- * @file ext_interrupts.h
- *
- * @brief Wiring-like external interrupt prototypes and types.
+ * @file wirish/include/wirish/ext_interrupts.h
+ * @brief Wiring-like external interrupt prototypes and types.
*/
#ifndef _WIRISH_EXT_INTERRUPTS_H_
diff --git a/wirish/include/wirish/io.h b/wirish/include/wirish/io.h
index de56a49..b5fe3a8 100644
--- a/wirish/include/wirish/io.h
+++ b/wirish/include/wirish/io.h
@@ -25,9 +25,8 @@
*****************************************************************************/
/**
- * @file io.h
- *
- * @brief Arduino-compatible digital pin I/O interface.
+ * @file wirish/include/wirish/io.h
+ * @brief Wiring-style pin I/O interface.
*/
#ifndef _WIRISH_IO_H_
diff --git a/wirish/include/wirish/pwm.h b/wirish/include/wirish/pwm.h
index e7130fb..6631d42 100644
--- a/wirish/include/wirish/pwm.h
+++ b/wirish/include/wirish/pwm.h
@@ -25,9 +25,8 @@
*****************************************************************************/
/**
- * @file pwm.h
- *
- * @brief Arduino-compatible PWM interface.
+ * @file wirish/include/wirish/pwm.h
+ * @brief Wiring-style PWM interface.
*/
#ifndef _WIRISH_PWM_H_
diff --git a/wirish/include/wirish/wirish_debug.h b/wirish/include/wirish/wirish_debug.h
index c8bc077..cb1be3d 100644
--- a/wirish/include/wirish/wirish_debug.h
+++ b/wirish/include/wirish/wirish_debug.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file wirish_debug.h
+ * @file wirish/include/wirish/wirish_debug.h
* @brief High level debug port configuration
*/
diff --git a/wirish/include/wirish/wirish_math.h b/wirish/include/wirish/wirish_math.h
index 3820cab..39f16a0 100644
--- a/wirish/include/wirish/wirish_math.h
+++ b/wirish/include/wirish/wirish_math.h
@@ -25,8 +25,8 @@
*****************************************************************************/
/**
- * @file wirish_math.h
- * @brief Includes <math.h>; provides Arduino-compatible math routines.
+ * @file wirish/include/wirish/wirish_math.h
+ * @brief Includes <math.h>; provides Wiring-compatible math routines.
*/
#ifndef _WIRISH_WIRISH_MATH_H_
diff --git a/wirish/include/wirish/wirish_time.h b/wirish/include/wirish/wirish_time.h
index a81075c..1520b1e 100644
--- a/wirish/include/wirish/wirish_time.h
+++ b/wirish/include/wirish/wirish_time.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file wirish_time.h
+ * @file wirish/include/wirish/wirish_time.h
* @brief Timing and delay functions.
*/
diff --git a/wirish/include/wirish/wirish_types.h b/wirish/include/wirish/wirish_types.h
index d70b26f..fce895e 100644
--- a/wirish/include/wirish/wirish_types.h
+++ b/wirish/include/wirish/wirish_types.h
@@ -25,7 +25,7 @@
*****************************************************************************/
/**
- * @file wirish_types.h
+ * @file wirish/include/wirish/wirish_types.h
* @author Marti Bolivar <mbolivar@leaflabs.com>
* @brief Wirish library type definitions.
*/