Add function documentation to the AVRISP project.

2009-08-25 13:15:30 +00:00
parent 73801c73a1
commit 8aee4cb2f2
7 changed files with 152 additions and 30 deletions
@@ -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: */