COMMON: Document Common::String::unsigned_type.

scummvm · Nov 23, 2013 · abe6d30 · abe6d30
1 parent 4c15e51
commit abe6d30
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/common/str.h b/common/str.h
@@ -235,6 +235,11 @@ class String {
 
 public:
 	typedef char          value_type;
+	/**
+	 * Unsigned version of the underlying type. This can be used to cast
+	 * individual string characters to bigger integer types without sign
+	 * extension happening.
+	 */
 	typedef unsigned char unsigned_type;
 	typedef char *        iterator;
 	typedef const char *  const_iterator;