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>

14 files changed, 19 insertions, 19 deletions

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>