Add function documentation to the AVRISP project.

[pub/USBasp.git] / Projects / Incomplete / AVRISP / Lib / V2ProtocolTarget.h

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