From 48e94ef721b6ddd73c36aed50b9bd2edcea96e8c Mon Sep 17 00:00:00 2001 From: Max Horn Date: Sun, 5 Oct 2003 13:10:53 +0000 Subject: [PATCH] added doxygen comment & TODOs svn-id: r10604 --- common/map.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/common/map.h b/common/map.h index bd3172f3142..8fde5cd693b 100644 --- a/common/map.h +++ b/common/map.h @@ -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 Map { protected: