Doc improvements in maps.h.
1.1 --- a/lemon/maps.h Fri Jan 04 08:16:15 2008 +0100
1.2 +++ b/lemon/maps.h Fri Jan 04 23:13:45 2008 +0100
1.3 @@ -44,9 +44,9 @@
1.4 template<typename K, typename T>
1.5 class MapBase {
1.6 public:
1.7 - ///\e
1.8 + /// The key type of the map.
1.9 typedef K Key;
1.10 - ///\e
1.11 + /// The value type of the map. (The type of objects associated with the keys).
1.12 typedef T Value;
1.13 };
1.14
1.15 @@ -249,9 +249,9 @@
1.16 };
1.17 };
1.18
1.19 - /// \brief Map for storing values for the range \c [0..size-1] range keys
1.20 + /// \brief Map for storing values for keys from the range <tt>[0..size-1]</tt>
1.21 ///
1.22 - /// The current map has the \c [0..size-1] keyset and the values
1.23 + /// The current map has the <tt>[0..size-1]</tt> keyset and the values
1.24 /// are stored in a \c std::vector<T> container. It can be used with
1.25 /// some data structures, for example \c UnionFind, \c BinHeap, when
1.26 /// the used items are small integer numbers.
1.27 @@ -829,7 +829,7 @@
1.28 ///
1.29 ///For example if \c m1 and \c m2 are both \c double valued maps, then
1.30 ///\code
1.31 - ///combineMap<double>(m1,m2,std::plus<double>())
1.32 + ///combineMap(m1,m2,std::plus<double>())
1.33 ///\endcode
1.34 ///is equivalent to
1.35 ///\code
1.36 @@ -962,8 +962,9 @@
1.37 ///of a given functor.
1.38 ///
1.39 ///Template parameters \c K and \c V will become its
1.40 - ///\c Key and \c Value. They must be given explicitly
1.41 - ///because a functor does not provide such typedefs.
1.42 + ///\c Key and \c Value.
1.43 + ///In most cases they have to be given explicitly because a
1.44 + ///functor typically does not provide such typedefs.
1.45 ///
1.46 ///Parameter \c F is the type of the used functor.
1.47 ///
1.48 @@ -1240,6 +1241,8 @@
1.49 ///\endcode
1.50 ///
1.51 ///\sa BackInserterBoolMap
1.52 + ///\sa FrontInserterBoolMap
1.53 + ///\sa InserterBoolMap
1.54 ///
1.55 ///\todo Revise the name of this class and the related ones.
1.56 template <typename _Iterator,