[Scummvm-cvs-logs] CVS: scummvm/common map.h,1.13,1.14

Max Horn fingolfin at users.sourceforge.net
Sun Oct 5 06:12:03 CEST 2003


Update of /cvsroot/scummvm/scummvm/common
In directory sc8-pr-cvs1:/tmp/cvs-serv32637

Modified Files:
	map.h 
Log Message:
added doxygen comment & TODOs

Index: map.h
===================================================================
RCS file: /cvsroot/scummvm/scummvm/common/map.h,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -r1.13 -r1.14
--- map.h	2 Oct 2003 17:43:01 -0000	1.13
+++ map.h	5 Oct 2003 13:10:53 -0000	1.14
@@ -25,6 +25,17 @@
 
 namespace Common {
 
+/**
+ * Template based map (aka dictionary) class which uniquely maps elements of
+ * class Key to elements of class Value.
+ *
+ * @todo This implementation is fairly limited. In particular, the tree is not
+ *       balanced. Ultimately this template should be reimplemented, e.g. using
+ *       a red-black tree. Or if one day using Std C++ lib becomes acceptable,
+ *       we can use that.
+ * @todo Having unit tests for class map would be very desirable. There are a 
+ *       big number of things which can go wrong in this code.
+ */
 template <class Key, class Value>
 class Map {
 protected:





More information about the Scummvm-git-logs mailing list