Minor doc fixes.
authorPeter Kovacs <kpeter@inf.elte.hu>
Mon, 07 Jan 2008 23:57:48 +0100
changeset 46b6dd98b57d71
parent 45 bc69cdfe171c
child 47 3750b8ebc91e
Minor doc fixes.
Replaced \c by \ref and \ref by \c to work properly and to be uniform.
lemon/maps.h
     1.1 --- a/lemon/maps.h	Mon Jan 07 23:36:33 2008 +0100
     1.2 +++ b/lemon/maps.h	Mon Jan 07 23:57:48 2008 +0100
     1.3 @@ -158,7 +158,7 @@
     1.4      return ConstMap<K, Const<V, v> >();
     1.5    }
     1.6  
     1.7 -  ///Map based on std::map
     1.8 +  ///Map based on \c std::map
     1.9  
    1.10    ///This is essentially a wrapper for \c std::map with addition that
    1.11    ///you can specify a default value different from \c Value().
    1.12 @@ -242,9 +242,9 @@
    1.13  
    1.14    };
    1.15    
    1.16 -  ///Returns a \ref StdMap class
    1.17 +  ///Returns a \c StdMap class
    1.18  
    1.19 -  ///This function just returns a \ref StdMap class with specified 
    1.20 +  ///This function just returns a \c StdMap class with specified 
    1.21    ///default value.
    1.22    ///\relates StdMap
    1.23    template<typename K, typename V, typename Compare = std::less<K> > 
    1.24 @@ -252,9 +252,9 @@
    1.25      return StdMap<K, V, Compare>(value);
    1.26    }
    1.27  
    1.28 -  ///Returns a \ref StdMap class created from an appropriate std::map
    1.29 +  ///Returns a \c StdMap class created from an appropriate std::map
    1.30  
    1.31 -  ///This function just returns a \ref StdMap class created from an 
    1.32 +  ///This function just returns a \c StdMap class created from an 
    1.33    ///appropriate std::map.
    1.34    ///\relates StdMap
    1.35    template<typename K, typename V, typename Compare = std::less<K> > 
    1.36 @@ -339,9 +339,9 @@
    1.37  
    1.38    };
    1.39    
    1.40 -  ///Returns an \ref IntegerMap class
    1.41 +  ///Returns an \c IntegerMap class
    1.42  
    1.43 -  ///This function just returns an \ref IntegerMap class.
    1.44 +  ///This function just returns an \c IntegerMap class.
    1.45    ///\relates IntegerMap
    1.46    template<typename T>
    1.47    inline IntegerMap<T> integerMap(int size = 0, const T& value = T()) {
    1.48 @@ -383,7 +383,7 @@
    1.49    ///\brief Convert the \c Value of a map to another type using
    1.50    ///the default conversion.
    1.51    ///
    1.52 -  ///This \c concepts::ReadMap "read only map"
    1.53 +  ///This \ref concepts::ReadMap "read only map"
    1.54    ///converts the \c Value of a map to type \c T.
    1.55    ///Its \c Key is inherited from \c M.
    1.56    template <typename M, typename T> 
    1.57 @@ -440,9 +440,9 @@
    1.58      Value operator[](Key k) const {return m[k];}
    1.59    };
    1.60    
    1.61 -  ///Returns a \ref SimpleMap class
    1.62 +  ///Returns a \c SimpleMap class
    1.63  
    1.64 -  ///This function just returns a \ref SimpleMap class.
    1.65 +  ///This function just returns a \c SimpleMap class.
    1.66    ///\relates SimpleMap
    1.67    template<typename M>
    1.68    inline SimpleMap<M> simpleMap(const M &m) {
    1.69 @@ -451,7 +451,7 @@
    1.70  
    1.71    ///Simple writable wrapping of a map
    1.72  
    1.73 -  ///This \ref concepts::WriteMap "write map" returns the simple
    1.74 +  ///This \ref concepts::ReadWriteMap "read-write map" returns the simple
    1.75    ///wrapping of the given map. Sometimes the reference maps cannot be
    1.76    ///combined with simple read-write maps. This map adaptor wraps the
    1.77    ///given map to simple read-write map.
    1.78 @@ -476,9 +476,9 @@
    1.79      void set(Key k, const Value& c) { m.set(k, c); }
    1.80    };
    1.81  
    1.82 -  ///Returns a \ref SimpleWriteMap class
    1.83 +  ///Returns a \c SimpleWriteMap class
    1.84  
    1.85 -  ///This function just returns a \ref SimpleWriteMap class.
    1.86 +  ///This function just returns a \c SimpleWriteMap class.
    1.87    ///\relates SimpleWriteMap
    1.88    template<typename M>
    1.89    inline SimpleWriteMap<M> simpleWriteMap(M &m) {
    1.90 @@ -487,7 +487,7 @@
    1.91  
    1.92    ///Sum of two maps
    1.93  
    1.94 -  ///This \c concepts::ReadMap "read only map" returns the sum of the two
    1.95 +  ///This \ref concepts::ReadMap "read only map" returns the sum of the two
    1.96    ///given maps.
    1.97    ///Its \c Key and \c Value are inherited from \c M1.
    1.98    ///The \c Key and \c Value of M2 must be convertible to those of \c M1.
    1.99 @@ -520,7 +520,7 @@
   1.100  
   1.101    ///Shift a map with a constant.
   1.102  
   1.103 -  ///This \c concepts::ReadMap "read only map" returns the sum of the
   1.104 +  ///This \ref concepts::ReadMap "read only map" returns the sum of the
   1.105    ///given map and a constant value.
   1.106    ///Its \c Key and \c Value are inherited from \c M.
   1.107    ///
   1.108 @@ -556,7 +556,7 @@
   1.109  
   1.110    ///Shift a map with a constant (ReadWrite version).
   1.111  
   1.112 -  ///This \c concepts::ReadWriteMap "read-write map" returns the sum of the
   1.113 +  ///This \ref concepts::ReadWriteMap "read-write map" returns the sum of the
   1.114    ///given map and a constant value. It makes also possible to write the map.
   1.115    ///Its \c Key and \c Value are inherited from \c M.
   1.116    ///
   1.117 @@ -602,7 +602,7 @@
   1.118  
   1.119    ///Difference of two maps
   1.120  
   1.121 -  ///This \c concepts::ReadMap "read only map" returns the difference
   1.122 +  ///This \ref concepts::ReadMap "read only map" returns the difference
   1.123    ///of the values of the two given maps.
   1.124    ///Its \c Key and \c Value are inherited from \c M1.
   1.125    ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
   1.126 @@ -635,7 +635,7 @@
   1.127  
   1.128    ///Product of two maps
   1.129  
   1.130 -  ///This \c concepts::ReadMap "read only map" returns the product of the
   1.131 +  ///This \ref concepts::ReadMap "read only map" returns the product of the
   1.132    ///values of the two given maps.
   1.133    ///Its \c Key and \c Value are inherited from \c M1.
   1.134    ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
   1.135 @@ -665,7 +665,7 @@
   1.136   
   1.137    ///Scales a map with a constant.
   1.138  
   1.139 -  ///This \c concepts::ReadMap "read only map" returns the value of the
   1.140 +  ///This \ref concepts::ReadMap "read only map" returns the value of the
   1.141    ///given map multiplied from the left side with a constant value.
   1.142    ///Its \c Key and \c Value are inherited from \c M.
   1.143    ///
   1.144 @@ -701,7 +701,7 @@
   1.145  
   1.146    ///Scales a map with a constant (ReadWrite version).
   1.147  
   1.148 -  ///This \c concepts::ReadWriteMap "read-write map" returns the value of the
   1.149 +  ///This \ref concepts::ReadWriteMap "read-write map" returns the value of the
   1.150    ///given map multiplied from the left side with a constant value. It can
   1.151    ///also be used as write map if the \c / operator is defined between
   1.152    ///\c Value and \c C and the given multiplier is not zero.
   1.153 @@ -749,7 +749,7 @@
   1.154  
   1.155    ///Quotient of two maps
   1.156  
   1.157 -  ///This \c concepts::ReadMap "read only map" returns the quotient of the
   1.158 +  ///This \ref concepts::ReadMap "read only map" returns the quotient of the
   1.159    ///values of the two given maps.
   1.160    ///Its \c Key and \c Value are inherited from \c M1.
   1.161    ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
   1.162 @@ -779,7 +779,7 @@
   1.163    
   1.164    ///Composition of two maps
   1.165  
   1.166 -  ///This \c concepts::ReadMap "read only map" returns the composition of
   1.167 +  ///This \ref concepts::ReadMap "read only map" returns the composition of
   1.168    ///two given maps.
   1.169    ///That is to say, if \c m1 is of type \c M1 and \c m2 is of \c M2,
   1.170    ///then for
   1.171 @@ -830,7 +830,7 @@
   1.172  
   1.173    ///Combine of two maps using an STL (binary) functor.
   1.174    ///
   1.175 -  ///This \c concepts::ReadMap "read only map" takes two maps and a
   1.176 +  ///This \ref concepts::ReadMap "read only map" takes two maps and a
   1.177    ///binary functor and returns the composition of the two
   1.178    ///given maps unsing the functor. 
   1.179    ///That is to say, if \c m1 and \c m2 is of type \c M1 and \c M2
   1.180 @@ -903,7 +903,7 @@
   1.181  
   1.182    ///Negative value of a map
   1.183  
   1.184 -  ///This \c concepts::ReadMap "read only map" returns the negative
   1.185 +  ///This \ref concepts::ReadMap "read only map" returns the negative
   1.186    ///value of the value returned by the given map.
   1.187    ///Its \c Key and \c Value are inherited from \c M.
   1.188    ///The unary \c - operator must be defined for \c Value, of course.
   1.189 @@ -925,7 +925,7 @@
   1.190    
   1.191    ///Negative value of a map (ReadWrite version)
   1.192  
   1.193 -  ///This \c concepts::ReadWriteMap "read-write map" returns the negative
   1.194 +  ///This \ref concepts::ReadWriteMap "read-write map" returns the negative
   1.195    ///value of the value returned by the given map.
   1.196    ///Its \c Key and \c Value are inherited from \c M.
   1.197    ///The unary \c - operator must be defined for \c Value, of course.
   1.198 @@ -967,7 +967,7 @@
   1.199  
   1.200    ///Absolute value of a map
   1.201  
   1.202 -  ///This \c concepts::ReadMap "read only map" returns the absolute value
   1.203 +  ///This \ref concepts::ReadMap "read only map" returns the absolute value
   1.204    ///of the value returned by the given map.
   1.205    ///Its \c Key and \c Value are inherited from \c M. 
   1.206    ///\c Value must be comparable to \c 0 and the unary \c -
   1.207 @@ -1001,7 +1001,7 @@
   1.208  
   1.209    ///Converts an STL style functor to a map
   1.210  
   1.211 -  ///This \c concepts::ReadMap "read only map" returns the value
   1.212 +  ///This \ref concepts::ReadMap "read only map" returns the value
   1.213    ///of a given functor.
   1.214    ///
   1.215    ///Template parameters \c K and \c V will become its
   1.216 @@ -1059,7 +1059,7 @@
   1.217    ///that is it provides an <tt>operator()</tt> to read its values.
   1.218    ///
   1.219    ///For the sake of convenience it also works as
   1.220 -  ///a ususal \c concepts::ReadMap "readable map",
   1.221 +  ///a ususal \ref concepts::ReadMap "readable map",
   1.222    ///i.e. <tt>operator[]</tt> and the \c Key and \c Value typedefs also exist.
   1.223    ///
   1.224    ///\sa FunctorMap
   1.225 @@ -1093,9 +1093,9 @@
   1.226  
   1.227    ///Applies all map setting operations to two maps
   1.228  
   1.229 -  ///This map has two \c concepts::ReadMap "readable map"
   1.230 +  ///This map has two \ref concepts::ReadMap "readable map"
   1.231    ///parameters and each read request will be passed just to the
   1.232 -  ///first map. This class is the just readable map type of the ForkWriteMap.
   1.233 +  ///first map. This class is the just readable map type of the \c ForkWriteMap.
   1.234    ///
   1.235    ///The \c Key and \c Value are inherited from \c M1.
   1.236    ///The \c Key and \c Value of M2 must be convertible from those of \c M1.
   1.237 @@ -1121,9 +1121,9 @@
   1.238  
   1.239    ///Applies all map setting operations to two maps
   1.240  
   1.241 -  ///This map has two \c concepts::WriteMap "writable map"
   1.242 +  ///This map has two \ref concepts::WriteMap "writable map"
   1.243    ///parameters and each write request will be passed to both of them.
   1.244 -  ///If \c M1 is also \c concepts::ReadMap "readable",
   1.245 +  ///If \c M1 is also \ref concepts::ReadMap "readable",
   1.246    ///then the read operations will return the
   1.247    ///corresponding values of \c M1.
   1.248    ///
   1.249 @@ -1172,7 +1172,7 @@
   1.250    
   1.251    ///Logical 'not' of a map
   1.252    
   1.253 -  ///This bool \c concepts::ReadMap "read only map" returns the 
   1.254 +  ///This bool \ref concepts::ReadMap "read only map" returns the 
   1.255    ///logical negation of the value returned by the given map.
   1.256    ///Its \c Key is inherited from \c M, its Value is \c bool.
   1.257    ///
   1.258 @@ -1193,7 +1193,7 @@
   1.259  
   1.260    ///Logical 'not' of a map (ReadWrie version)
   1.261    
   1.262 -  ///This bool \c concepts::ReadWriteMap "read-write map" returns the 
   1.263 +  ///This bool \ref concepts::ReadWriteMap "read-write map" returns the 
   1.264    ///logical negation of the value returned by the given map. When it is set,
   1.265    ///the opposite value is set to the original map.
   1.266    ///Its \c Key is inherited from \c M, its Value is \c bool.
   1.267 @@ -1261,8 +1261,9 @@
   1.268  
   1.269    /// \brief Writable bool map for logging each \c true assigned element
   1.270    ///
   1.271 -  /// Writable bool map for logging each \c true assigned element, i.e it
   1.272 -  /// copies all the keys set to \c true to the given iterator.
   1.273 +  /// A \ref concepts::ReadWriteMap "read-write" bool map for logging 
   1.274 +  /// each \c true assigned element, i.e it/ copies all the keys set 
   1.275 +  /// to \c true to the given iterator.
   1.276    ///
   1.277    /// \note The container of the iterator should contain space 
   1.278    /// for each element.