gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Doc improvements in maps.h.
0 1 0
default
1 file changed with 10 insertions and 7 deletions:
↑ Collapse diff ↑
Ignore white space 6 line context
... ...
@@ -44,9 +44,9 @@
44 44
  template<typename K, typename T>
45 45
  class MapBase {
46 46
  public:
47
    ///\e
47
    /// The key type of the map.
48 48
    typedef K Key;
49
    ///\e
49
    /// The value type of the map. (The type of objects associated with the keys).
50 50
    typedef T Value;
51 51
  };
52 52

	
... ...
@@ -249,9 +249,9 @@
249 249
    };
250 250
  };
251 251

	
252
  /// \brief Map for storing values for the range \c [0..size-1] range keys
252
  /// \brief Map for storing values for keys from the range <tt>[0..size-1]</tt>
253 253
  ///
254
  /// The current map has the \c [0..size-1] keyset and the values
254
  /// The current map has the <tt>[0..size-1]</tt> keyset and the values
255 255
  /// are stored in a \c std::vector<T>  container. It can be used with
256 256
  /// some data structures, for example \c UnionFind, \c BinHeap, when 
257 257
  /// the used items are small integer numbers. 
... ...
@@ -829,7 +829,7 @@
829 829
  ///
830 830
  ///For example if \c m1 and \c m2 are both \c double valued maps, then 
831 831
  ///\code
832
  ///combineMap<double>(m1,m2,std::plus<double>())
832
  ///combineMap(m1,m2,std::plus<double>())
833 833
  ///\endcode
834 834
  ///is equivalent to
835 835
  ///\code
... ...
@@ -962,8 +962,9 @@
962 962
  ///of a given functor.
963 963
  ///
964 964
  ///Template parameters \c K and \c V will become its
965
  ///\c Key and \c Value. They must be given explicitly
966
  ///because a functor does not provide such typedefs.
965
  ///\c Key and \c Value. 
966
  ///In most cases they have to be given explicitly because a 
967
  ///functor typically does not provide such typedefs.
967 968
  ///
968 969
  ///Parameter \c F is the type of the used functor.
969 970
  ///
... ...
@@ -1240,6 +1241,8 @@
1240 1241
  ///\endcode
1241 1242
  ///
1242 1243
  ///\sa BackInserterBoolMap 
1244
  ///\sa FrontInserterBoolMap 
1245
  ///\sa InserterBoolMap 
1243 1246
  ///
1244 1247
  ///\todo Revise the name of this class and the related ones.
1245 1248
  template <typename _Iterator, 
0 comments (0 inline)