Changeset 28:e337bdf46777 in lemon-main

Timestamp:

01/04/08 03:29:54 (17 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Children:

31:742abd64255e, 35:f8ddf1b1541a

Phase:

public

Message:

Doc improvements.

File:

• lemon/concepts/maps.h (modified) (7 diffs)

lemon/concepts/maps.h

@@ -35 +35 @@
 
     /// Readable map concept
+
+    /// Readable map concept.
+    ///
     template<typename K, typename T>
     class ReadMap
@@ -46 +49 @@
       /// Returns the value associated with a key.
 
-      /// \bug Value should n't need to be default constructible.
+      /// \bug Value shouldn't need to be default constructible.
       ///
       Value operator[](const Key &) const {return Value();}
@@ -72 +75 @@
 
     /// Writable map concept
+    
+    /// Writable map concept.
+    ///
     template<typename K, typename T>
     class WriteMap
@@ -108 +114 @@
     };
 
-    ///Read/Writable map concept
+    /// Read/Writable map concept
+    
+    /// Read/writable map concept.
+    ///
     template<typename K, typename T>
     class ReadWriteMap : public ReadMap<K,T>,
@@ -134 +143 @@
   
   
-    ///Dereferable map concept
+    /// Dereferable map concept
+    
+    /// Dereferable map concept.
+    ///
     template<typename K, typename T, typename R, typename CR>
     class ReferenceMap : public ReadWriteMap<K,T>
@@ -157 +169 @@
       Reference operator[](const Key &) { return tmp; }
       ///Returns a const reference to the value associated to a key.
-      ConstReference operator[](const Key &) const
-      { return tmp; }
+      ConstReference operator[](const Key &) const { return tmp; }
       /// Sets the value associated with a key.
       void set(const Key &k,const Value &t) { operator[](k)=t; }
 
-      // \todo rethink this concept
+      /// \todo Rethink this concept. 
       template<typename _ReferenceMap>
       struct ReferenceMapConcept {
@@ -191 +202 @@
 
   } //namespace concepts
+
 } //namespace lemon
+
 #endif // LEMON_CONCEPT_MAPS_H