From 09de1019a60125f3f5932a21377670d3cb030121 Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@leaflabs.com>
Date: Wed, 30 Mar 2011 03:44:57 -0400
Subject: Nitpicks

---
 libmaple/scb.h | 4 ++++
 wirish/io.h    | 2 +-
 2 files changed, 5 insertions(+), 1 deletion(-)

diff --git a/libmaple/scb.h b/libmaple/scb.h
index f851a08..8bfdda3 100644
--- a/libmaple/scb.h
+++ b/libmaple/scb.h
@@ -29,6 +29,8 @@
 #ifndef _SCB_H_
 #define _SCB_H_
 
+/* FIXME this definition is missing doxygen comments */
+
 typedef struct scb_reg_map {
   __io uint32 CPUID;            // CPU ID Base Register
   __io uint32 ICSR;             // Interrupt Control State Register
@@ -51,6 +53,8 @@ typedef struct scb_reg_map {
   __io uint32 ISAR[5];          // ISA Feature Register
 } scb_reg_map;
 
+/* FIXME these names violate the libmaple naming conventions */
+
 #define SCB_BASE            0xE000ED00
 #define SCB                 ((scb_reg_map*)(SCB_BASE))
 
diff --git a/wirish/io.h b/wirish/io.h
index 7d4fab1..0ffbd10 100644
--- a/wirish/io.h
+++ b/wirish/io.h
@@ -223,7 +223,7 @@ uint8 waitForButtonPress(uint32 timeout_millis=0);
  * @param dataPin  Pin to shift data out on
  * @param clockPin Pin to pulse after each bit is shifted out
  * @param bitOrder Either MSBFIRST (big-endian) or LSBFIRST (little-endian).
- * @param val      Value to shift out
+ * @param value    Value to shift out
  */
 void shiftOut(uint8 dataPin, uint8 clockPin, uint8 bitOrder, uint8 value);
 
-- 
cgit v1.2.3