Changeset 33:d794ec195ec0 in lemon-main

Timestamp:

01/04/08 23:13:45 (17 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Doc improvements in maps.h.

File:

• lemon/maps.h (modified) (5 diffs)

lemon/maps.h

@@ -45 +45 @@
   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 +250 @@
   };
 
-  /// \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 <tt>[0..size-1]</tt>
+  ///
+  /// The current map has the <tt>[0..size-1]</tt> keyset and the values
   /// are stored in a \c std::vector<T>  container. It can be used with
   /// some data structures, for example \c UnionFind, \c BinHeap, when 
@@ -830 +830 @@
   ///For example if \c m1 and \c m2 are both \c double valued maps, then 
   ///\code
-  ///combineMap<double>(m1,m2,std::plus<double>())
+  ///combineMap(m1,m2,std::plus<double>())
   ///\endcode
   ///is equivalent to
@@ -963 +963 @@
   ///
   ///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 +1242 @@
   ///
   ///\sa BackInserterBoolMap 
+  ///\sa FrontInserterBoolMap 
+  ///\sa InserterBoolMap 
   ///
   ///\todo Revise the name of this class and the related ones.