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>

22 files changed, 23 insertions, 24 deletions

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.
  */