Minor documentation fixes.

2011-05-08 14:30:36 +00:00
parent 71c5d4e3e5
commit a85fa30bf1
4 changed files with 10 additions and 3 deletions
@@ -73,7 +73,10 @@
 		
 	/* Architecture specific utility includes: */
 		#if defined(__DOXYGEN__)
-			/** Type define for an unsigned integer the same width as the selected architecture's machine register. */
+			/** Type define for an unsigned integer the same width as the selected architecture's machine register.
+			 *  This is distinct from the non-specific standard int data type, whose width is machine dependant but
+			 *  which may not reflect the actual machine register width on some targets (e.g. AVR8).
+			 */
 			typedef MACHINE_REG_t uint_reg_t;
 		#elif (ARCH == ARCH_AVR8)
 			#include <avr/io.h>