From b5c11895b59fbfdc6dda9d26e02df053f8035ff2 Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@leaflabs.com>
Date: Tue, 8 May 2012 16:22:41 -0400
Subject: 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>
---
 wirish/HardwareSerial.cpp              | 2 +-
 wirish/boards.cpp                      | 2 +-
 wirish/ext_interrupts.cpp              | 5 ++---
 wirish/include/wirish/HardwareSPI.h    | 2 +-
 wirish/include/wirish/HardwareSerial.h | 2 +-
 wirish/include/wirish/boards.h         | 4 ++--
 wirish/include/wirish/ext_interrupts.h | 5 ++---
 wirish/include/wirish/io.h             | 5 ++---
 wirish/include/wirish/pwm.h            | 5 ++---
 wirish/include/wirish/wirish_debug.h   | 2 +-
 wirish/include/wirish/wirish_math.h    | 4 ++--
 wirish/include/wirish/wirish_time.h    | 2 +-
 wirish/include/wirish/wirish_types.h   | 2 +-
 13 files changed, 19 insertions(+), 23 deletions(-)

(limited to 'wirish')

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.
  */
-- 
cgit v1.2.3