# HG changeset patch # User Peter Kovacs # Date 1199484825 -3600 # Node ID d794ec195ec0c10946ae30c8e622e1c32a97b3f8 # Parent 72364ba3466d1a07ad4b6313794d792d3e35dd6d Doc improvements in maps.h. diff -r 72364ba3466d -r d794ec195ec0 lemon/maps.h --- a/lemon/maps.h Fri Jan 04 08:16:15 2008 +0100 +++ b/lemon/maps.h Fri Jan 04 23:13:45 2008 +0100 @@ -44,9 +44,9 @@ template class MapBase { public: - ///\e + /// The key type of the map. typedef K Key; - ///\e + /// The value type of the map. (The type of objects associated with the keys). typedef T Value; }; @@ -249,9 +249,9 @@ }; }; - /// \brief Map for storing values for the range \c [0..size-1] range keys + /// \brief Map for storing values for keys from the range [0..size-1] /// - /// The current map has the \c [0..size-1] keyset and the values + /// The current map has the [0..size-1] keyset and the values /// are stored in a \c std::vector container. It can be used with /// some data structures, for example \c UnionFind, \c BinHeap, when /// the used items are small integer numbers. @@ -829,7 +829,7 @@ /// ///For example if \c m1 and \c m2 are both \c double valued maps, then ///\code - ///combineMap(m1,m2,std::plus()) + ///combineMap(m1,m2,std::plus()) ///\endcode ///is equivalent to ///\code @@ -962,8 +962,9 @@ ///of a given functor. /// ///Template parameters \c K and \c V will become its - ///\c Key and \c Value. They must be given explicitly - ///because a functor does not provide such typedefs. + ///\c Key and \c Value. + ///In most cases they have to be given explicitly because a + ///functor typically does not provide such typedefs. /// ///Parameter \c F is the type of the used functor. /// @@ -1240,6 +1241,8 @@ ///\endcode /// ///\sa BackInserterBoolMap + ///\sa FrontInserterBoolMap + ///\sa InserterBoolMap /// ///\todo Revise the name of this class and the related ones. template