From fc92f9969c1fcc2f952f0bd6d09a309a9b3ce02f Mon Sep 17 00:00:00 2001
From: Dean Camera <dean@fourwalledcubicle.com>
Date: Thu, 3 Jun 2010 15:32:45 +0000
Subject: Minor documentation cleanups.

---
 Projects/AVRISP-MKII/Lib/ISP/ISPProtocol.h   | 2 +-
 Projects/AVRISP-MKII/Lib/ISP/ISPTarget.h     | 3 ++-
 Projects/AVRISP-MKII/Lib/V2Protocol.h        | 8 ++++----
 Projects/AVRISP-MKII/Lib/V2ProtocolParams.h  | 4 ++--
 Projects/AVRISP-MKII/Lib/XPROG/XPROGTarget.h | 4 ++--
 5 files changed, 11 insertions(+), 10 deletions(-)

(limited to 'Projects/AVRISP-MKII')

diff --git a/Projects/AVRISP-MKII/Lib/ISP/ISPProtocol.h b/Projects/AVRISP-MKII/Lib/ISP/ISPProtocol.h
index c983f49c6..bc6bb5de1 100644
--- a/Projects/AVRISP-MKII/Lib/ISP/ISPProtocol.h
+++ b/Projects/AVRISP-MKII/Lib/ISP/ISPProtocol.h
@@ -54,7 +54,7 @@
 		#endif
 
 	/* Macros: */
-		/** Mask for the reading or writing of the high byte in a FLASH word when issuing a low-level programming command */
+		/** Mask for the reading or writing of the high byte in a FLASH word when issuing a low-level programming command. */
 		#define READ_WRITE_HIGH_BYTE_MASK       (1 << 3)
 
 		#define PROG_MODE_PAGED_WRITES_MASK     (1 << 0)
diff --git a/Projects/AVRISP-MKII/Lib/ISP/ISPTarget.h b/Projects/AVRISP-MKII/Lib/ISP/ISPTarget.h
index 705dd3990..34d623ed7 100644
--- a/Projects/AVRISP-MKII/Lib/ISP/ISPTarget.h
+++ b/Projects/AVRISP-MKII/Lib/ISP/ISPTarget.h
@@ -56,9 +56,10 @@
 		#endif
 
 	/* Macros: */
-		/** Total number of allowable ISP programming speeds supported by the device */
+		/** Total number of allowable ISP programming speeds supported by the device. */
 		#define TOTAL_ISP_PROGRAMMING_SPEEDS  7
 		
+		/** Low level device command to issue an extended FLASH address, for devices with other 128KB of FLASH. */
 		#define LOAD_EXTENDED_ADDRESS_CMD     0x4D
 		
 	/* Function Prototypes: */
diff --git a/Projects/AVRISP-MKII/Lib/V2Protocol.h b/Projects/AVRISP-MKII/Lib/V2Protocol.h
index d5602a0d4..5b8589294 100644
--- a/Projects/AVRISP-MKII/Lib/V2Protocol.h
+++ b/Projects/AVRISP-MKII/Lib/V2Protocol.h
@@ -63,16 +63,16 @@
 			#define _GETADCMUXMASK(x, y)        _GETADCMUXMASK2(x, y)
 		#endif
 
-		/** Programmer ID string, returned to the host during the CMD_SIGN_ON command processing */
+		/** Programmer ID string, returned to the host during the CMD_SIGN_ON command processing. */
 		#define PROGRAMMER_ID              "AVRISP_MK2"
 		
-		/** Timeout period for each issued command from the host before it is aborted */
+		/** Timeout period for each issued command from the host before it is aborted. */
 		#define COMMAND_TIMEOUT_MS         200
 		
-		/** Command timeout counter register, GPIOR for speed */
+		/** Command timeout counter register, GPIOR for speed. */
 		#define TimeoutMSRemaining         GPIOR0
 
-		/** MUX mask for the VTARGET ADC channel number */
+		/** MUX mask for the VTARGET ADC channel number. */
 		#define VTARGET_ADC_CHANNEL_MASK   _GETADCMUXMASK(ADC_CHANNEL, VTARGET_ADC_CHANNEL)
 		
 		#if !defined(WIN_AVRDUDE_COMPAT)
diff --git a/Projects/AVRISP-MKII/Lib/V2ProtocolParams.h b/Projects/AVRISP-MKII/Lib/V2ProtocolParams.h
index 4bbb02419..d93aaddbf 100644
--- a/Projects/AVRISP-MKII/Lib/V2ProtocolParams.h
+++ b/Projects/AVRISP-MKII/Lib/V2ProtocolParams.h
@@ -51,10 +51,10 @@
 		#include "ISP/ISPTarget.h"
 
 	/* Macros: */
-		/** Parameter privilege mask to allow the host PC to read the parameter's value */
+		/** Parameter privilege mask to allow the host PC to read the parameter's value. */
 		#define PARAM_PRIV_READ     (1 << 0)
 
-		/** Parameter privilege mask to allow the host PC to change the parameter's value */
+		/** Parameter privilege mask to allow the host PC to change the parameter's value. */
 		#define PARAM_PRIV_WRITE    (1 << 1)
 		
 		/** Total number of parameters in the parameter table */
diff --git a/Projects/AVRISP-MKII/Lib/XPROG/XPROGTarget.h b/Projects/AVRISP-MKII/Lib/XPROG/XPROGTarget.h
index db233a1a4..3cb73ce90 100644
--- a/Projects/AVRISP-MKII/Lib/XPROG/XPROGTarget.h
+++ b/Projects/AVRISP-MKII/Lib/XPROG/XPROGTarget.h
@@ -55,10 +55,10 @@
 			#endif
 		#endif
 		
-		/** Serial carrier TPI/PDI speed when hardware TPI/PDI mode is used */
+		/** Serial carrier TPI/PDI speed when hardware TPI/PDI mode is used. */
 		#define XPROG_HARDWARE_SPEED       1000000
 
-		/** Total number of bits in a single USART frame */
+		/** Total number of bits in a single USART frame. */
 		#define BITS_IN_USART_FRAME        12
 		
 		#define PDI_CMD_LDS                0x00
-- 
cgit v1.2.3