From 8aee4cb2f2207e93841664814bb1dbfc1347894c Mon Sep 17 00:00:00 2001
From: Dean Camera <dean@fourwalledcubicle.com>
Date: Tue, 25 Aug 2009 13:15:30 +0000
Subject: Add function documentation to the AVRISP project.

---
 Projects/Incomplete/AVRISP/Lib/V2ProtocolTarget.h | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

(limited to 'Projects/Incomplete/AVRISP/Lib/V2ProtocolTarget.h')

diff --git a/Projects/Incomplete/AVRISP/Lib/V2ProtocolTarget.h b/Projects/Incomplete/AVRISP/Lib/V2ProtocolTarget.h
index 6dce59d6c..1e0364d9c 100644
--- a/Projects/Incomplete/AVRISP/Lib/V2ProtocolTarget.h
+++ b/Projects/Incomplete/AVRISP/Lib/V2ProtocolTarget.h
@@ -58,10 +58,14 @@
 		extern uint32_t CurrentAddress;
 
 	/* Inline Functions: */
-		static inline void V2Protocol_DelayMS(uint8_t MS)
+		/** Blocking delay for a given number of milliseconds, via a hardware timer.
+		 *
+		 *  \param DelayMS  Number of milliseconds to delay for
+		 */
+		static inline void V2Protocol_DelayMS(uint8_t DelayMS)
 		{
 			TCNT0 = 0;
-			while (TCNT0 < MS);
+			while (TCNT0 < DelayMS);
 		}
 
 	/* Function Prototypes: */
-- 
cgit v1.2.3