Index: lemon/maps.h
===================================================================
--- lemon/maps.h (revision 30)
+++ lemon/maps.h (revision 33)
@@ -45,7 +45,7 @@
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;
};
@@ -250,7 +250,7 @@
};
- /// \brief Map for storing values for the range \c [0..size-1] range keys
- ///
- /// The current map has the \c [0..size-1] keyset and the values
+ /// \brief Map for storing values for keys from the range [0..size-1]
+ ///
+ /// 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
@@ -830,5 +830,5 @@
///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
@@ -963,6 +963,7 @@
///
///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.
@@ -1241,4 +1242,6 @@
///
///\sa BackInserterBoolMap
+ ///\sa FrontInserterBoolMap
+ ///\sa InserterBoolMap
///
///\todo Revise the name of this class and the related ones.