Minor doc improvements.
authorPeter Kovacs <kpeter@inf.elte.hu>
Tue, 08 Jan 2008 02:21:01 +0100
changeset 4893ae269876de
parent 47 3750b8ebc91e
child 51 90201bb15a8d
Minor doc improvements.
lemon/concepts/maps.h
     1.1 --- a/lemon/concepts/maps.h	Tue Jan 08 02:12:50 2008 +0100
     1.2 +++ b/lemon/concepts/maps.h	Tue Jan 08 02:21:01 2008 +0100
     1.3 @@ -48,6 +48,7 @@
     1.4  
     1.5        /// Returns the value associated with a key.
     1.6  
     1.7 +      /// Returns the value associated with a key.
     1.8        /// \bug Value shouldn't need to be default constructible.
     1.9        ///
    1.10        Value operator[](const Key &) const {return Value();}
    1.11 @@ -113,7 +114,7 @@
    1.12        };
    1.13      };
    1.14  
    1.15 -    /// Read/Writable map concept
    1.16 +    /// Read/writable map concept
    1.17      
    1.18      /// Read/writable map concept.
    1.19      ///
    1.20 @@ -146,6 +147,7 @@
    1.21      
    1.22      /// Dereferable map concept.
    1.23      ///
    1.24 +    /// \todo Rethink this concept.
    1.25      template<typename K, typename T, typename R, typename CR>
    1.26      class ReferenceMap : public ReadWriteMap<K,T>
    1.27      {
    1.28 @@ -165,14 +167,13 @@
    1.29        Value tmp;
    1.30      public:
    1.31  
    1.32 -      ///Returns a reference to the value associated to a key.
    1.33 +      ///Returns a reference to the value associated with a key.
    1.34        Reference operator[](const Key &) { return tmp; }
    1.35 -      ///Returns a const reference to the value associated to a key.
    1.36 +      ///Returns a const reference to the value associated with a key.
    1.37        ConstReference operator[](const Key &) const { return tmp; }
    1.38        /// Sets the value associated with a key.
    1.39        void set(const Key &k,const Value &t) { operator[](k)=t; }
    1.40  
    1.41 -      /// \todo Rethink this concept. 
    1.42        template<typename _ReferenceMap>
    1.43        struct ReferenceMapConcept {
    1.44