Changeset 805:59b8cb2cb2f8 in lemon-0.x

Timestamp:

09/06/04 10:22:48 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1099

Message:

Changes in doc.

File:

• src/hugo/maps.h (modified) (5 diffs)

src/hugo/maps.h

@@ -15 +15 @@
   /// Base class of maps.
 
+  /// Base class of maps.
+  /// It provides the necessary <tt>typedef</tt>s required by the map concept.
   template<typename K, typename T>
   class MapBase
   {
   public:
-    ///
+    /// .
     typedef K KeyType;
-    ///
+    /// .
     typedef T ValueType;
   };
 
-  /// Null map. (aka DoNothingMap)
+  /// Null map. (a.k.a. DoNothingMap)
 
   /// If you have to provide a map only for its type definitions,
-  /// or if you have to provide a writable map, but will not use the
-  /// data written to it...
+  /// or if you have to provide a writable map, but
+  /// data written to it will sent to <tt>/dev/null</tt>...
   template<typename K, typename T>
   class NullMap : public MapBase<K,T>
@@ -35 +37 @@
   public:
 
+    /// Gives back a default constructed element.
     T operator[](const K&) const { return T(); }
+    /// Absorbs the value.
     void set(const K&, const T&) {}
-    ///\bug when update is removed from map concepts by being dynamic
-    ///stuffs, this line have to be removed.
-    void update() { }
   };
 
@@ -45 +46 @@
   /// Constant map.
 
-  /// This is a readable map which assignes a specified value to each key.
-  /// In other aspects it is equivalent to the \ref NullMap
+  /// This is a readable map which assigns a specified value to each key.
+  /// In other aspects it is equivalent to the \ref NullMap.
+  /// \todo set could be used to set the value.
   template<typename K, typename T>
   class ConstMap : public MapBase<K,T>
@@ -53 +55 @@
   public:
 
+    /// Default constructor
+
+    /// The value of the map will be uninitialized. 
+    /// (More exactly it will be default constructed.)
     ConstMap() {}
+    /// .
+
+    /// \param _v The initial value of the map.
     ConstMap(const T &_v) : v(_v) {}
 
@@ -124 +133 @@
     /// \return Returns the previous default value.
     ///
-    /// \warning The value of some keys (which has alredy been queried, but
+    /// \warning The value of some keys (which has already been queried, but
     /// the value has been unchanged from the default) may change!
     T setDefault(const T &_v) { T old=v; v=_v; return old; }