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>

8 files changed, 15 insertions, 13 deletions

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_