# HG changeset patch # User Peter Kovacs # Date 2008-01-07 23:57:48 # Node ID b6dd98b57d7181a1516c3925a2aabb40fad43883 # Parent bc69cdfe171c893e2e1aeb0a343b32c6420ba861 Minor doc fixes. Replaced \c by \ref and \ref by \c to work properly and to be uniform. diff --git a/lemon/maps.h b/lemon/maps.h --- a/lemon/maps.h +++ b/lemon/maps.h @@ -158,7 +158,7 @@ return ConstMap >(); } - ///Map based on std::map + ///Map based on \c std::map ///This is essentially a wrapper for \c std::map with addition that ///you can specify a default value different from \c Value(). @@ -242,9 +242,9 @@ }; - ///Returns a \ref StdMap class + ///Returns a \c StdMap class - ///This function just returns a \ref StdMap class with specified + ///This function just returns a \c StdMap class with specified ///default value. ///\relates StdMap template > @@ -252,9 +252,9 @@ return StdMap(value); } - ///Returns a \ref StdMap class created from an appropriate std::map + ///Returns a \c StdMap class created from an appropriate std::map - ///This function just returns a \ref StdMap class created from an + ///This function just returns a \c StdMap class created from an ///appropriate std::map. ///\relates StdMap template > @@ -339,9 +339,9 @@ }; - ///Returns an \ref IntegerMap class + ///Returns an \c IntegerMap class - ///This function just returns an \ref IntegerMap class. + ///This function just returns an \c IntegerMap class. ///\relates IntegerMap template inline IntegerMap integerMap(int size = 0, const T& value = T()) { @@ -383,7 +383,7 @@ ///\brief Convert the \c Value of a map to another type using ///the default conversion. /// - ///This \c concepts::ReadMap "read only map" + ///This \ref concepts::ReadMap "read only map" ///converts the \c Value of a map to type \c T. ///Its \c Key is inherited from \c M. template @@ -440,9 +440,9 @@ Value operator[](Key k) const {return m[k];} }; - ///Returns a \ref SimpleMap class + ///Returns a \c SimpleMap class - ///This function just returns a \ref SimpleMap class. + ///This function just returns a \c SimpleMap class. ///\relates SimpleMap template inline SimpleMap simpleMap(const M &m) { @@ -451,7 +451,7 @@ ///Simple writable wrapping of a map - ///This \ref concepts::WriteMap "write map" returns the simple + ///This \ref concepts::ReadWriteMap "read-write map" returns the simple ///wrapping of the given map. Sometimes the reference maps cannot be ///combined with simple read-write maps. This map adaptor wraps the ///given map to simple read-write map. @@ -476,9 +476,9 @@ void set(Key k, const Value& c) { m.set(k, c); } }; - ///Returns a \ref SimpleWriteMap class + ///Returns a \c SimpleWriteMap class - ///This function just returns a \ref SimpleWriteMap class. + ///This function just returns a \c SimpleWriteMap class. ///\relates SimpleWriteMap template inline SimpleWriteMap simpleWriteMap(M &m) { @@ -487,7 +487,7 @@ ///Sum of two maps - ///This \c concepts::ReadMap "read only map" returns the sum of the two + ///This \ref concepts::ReadMap "read only map" returns the sum of the two ///given maps. ///Its \c Key and \c Value are inherited from \c M1. ///The \c Key and \c Value of M2 must be convertible to those of \c M1. @@ -520,7 +520,7 @@ ///Shift a map with a constant. - ///This \c concepts::ReadMap "read only map" returns the sum of the + ///This \ref concepts::ReadMap "read only map" returns the sum of the ///given map and a constant value. ///Its \c Key and \c Value are inherited from \c M. /// @@ -556,7 +556,7 @@ ///Shift a map with a constant (ReadWrite version). - ///This \c concepts::ReadWriteMap "read-write map" returns the sum of the + ///This \ref concepts::ReadWriteMap "read-write map" returns the sum of the ///given map and a constant value. It makes also possible to write the map. ///Its \c Key and \c Value are inherited from \c M. /// @@ -602,7 +602,7 @@ ///Difference of two maps - ///This \c concepts::ReadMap "read only map" returns the difference + ///This \ref concepts::ReadMap "read only map" returns the difference ///of the values of the two given maps. ///Its \c Key and \c Value are inherited from \c M1. ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1. @@ -635,7 +635,7 @@ ///Product of two maps - ///This \c concepts::ReadMap "read only map" returns the product of the + ///This \ref concepts::ReadMap "read only map" returns the product of the ///values of the two given maps. ///Its \c Key and \c Value are inherited from \c M1. ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1. @@ -665,7 +665,7 @@ ///Scales a map with a constant. - ///This \c concepts::ReadMap "read only map" returns the value of the + ///This \ref concepts::ReadMap "read only map" returns the value of the ///given map multiplied from the left side with a constant value. ///Its \c Key and \c Value are inherited from \c M. /// @@ -701,7 +701,7 @@ ///Scales a map with a constant (ReadWrite version). - ///This \c concepts::ReadWriteMap "read-write map" returns the value of the + ///This \ref concepts::ReadWriteMap "read-write map" returns the value of the ///given map multiplied from the left side with a constant value. It can ///also be used as write map if the \c / operator is defined between ///\c Value and \c C and the given multiplier is not zero. @@ -749,7 +749,7 @@ ///Quotient of two maps - ///This \c concepts::ReadMap "read only map" returns the quotient of the + ///This \ref concepts::ReadMap "read only map" returns the quotient of the ///values of the two given maps. ///Its \c Key and \c Value are inherited from \c M1. ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1. @@ -779,7 +779,7 @@ ///Composition of two maps - ///This \c concepts::ReadMap "read only map" returns the composition of + ///This \ref concepts::ReadMap "read only map" returns the composition of ///two given maps. ///That is to say, if \c m1 is of type \c M1 and \c m2 is of \c M2, ///then for @@ -830,7 +830,7 @@ ///Combine of two maps using an STL (binary) functor. /// - ///This \c concepts::ReadMap "read only map" takes two maps and a + ///This \ref concepts::ReadMap "read only map" takes two maps and a ///binary functor and returns the composition of the two ///given maps unsing the functor. ///That is to say, if \c m1 and \c m2 is of type \c M1 and \c M2 @@ -903,7 +903,7 @@ ///Negative value of a map - ///This \c concepts::ReadMap "read only map" returns the negative + ///This \ref concepts::ReadMap "read only map" returns the negative ///value of the value returned by the given map. ///Its \c Key and \c Value are inherited from \c M. ///The unary \c - operator must be defined for \c Value, of course. @@ -925,7 +925,7 @@ ///Negative value of a map (ReadWrite version) - ///This \c concepts::ReadWriteMap "read-write map" returns the negative + ///This \ref concepts::ReadWriteMap "read-write map" returns the negative ///value of the value returned by the given map. ///Its \c Key and \c Value are inherited from \c M. ///The unary \c - operator must be defined for \c Value, of course. @@ -967,7 +967,7 @@ ///Absolute value of a map - ///This \c concepts::ReadMap "read only map" returns the absolute value + ///This \ref concepts::ReadMap "read only map" returns the absolute value ///of the value returned by the given map. ///Its \c Key and \c Value are inherited from \c M. ///\c Value must be comparable to \c 0 and the unary \c - @@ -1001,7 +1001,7 @@ ///Converts an STL style functor to a map - ///This \c concepts::ReadMap "read only map" returns the value + ///This \ref concepts::ReadMap "read only map" returns the value ///of a given functor. /// ///Template parameters \c K and \c V will become its @@ -1059,7 +1059,7 @@ ///that is it provides an operator() to read its values. /// ///For the sake of convenience it also works as - ///a ususal \c concepts::ReadMap "readable map", + ///a ususal \ref concepts::ReadMap "readable map", ///i.e. operator[] and the \c Key and \c Value typedefs also exist. /// ///\sa FunctorMap @@ -1093,9 +1093,9 @@ ///Applies all map setting operations to two maps - ///This map has two \c concepts::ReadMap "readable map" + ///This map has two \ref concepts::ReadMap "readable map" ///parameters and each read request will be passed just to the - ///first map. This class is the just readable map type of the ForkWriteMap. + ///first map. This class is the just readable map type of the \c ForkWriteMap. /// ///The \c Key and \c Value are inherited from \c M1. ///The \c Key and \c Value of M2 must be convertible from those of \c M1. @@ -1121,9 +1121,9 @@ ///Applies all map setting operations to two maps - ///This map has two \c concepts::WriteMap "writable map" + ///This map has two \ref concepts::WriteMap "writable map" ///parameters and each write request will be passed to both of them. - ///If \c M1 is also \c concepts::ReadMap "readable", + ///If \c M1 is also \ref concepts::ReadMap "readable", ///then the read operations will return the ///corresponding values of \c M1. /// @@ -1172,7 +1172,7 @@ ///Logical 'not' of a map - ///This bool \c concepts::ReadMap "read only map" returns the + ///This bool \ref concepts::ReadMap "read only map" returns the ///logical negation of the value returned by the given map. ///Its \c Key is inherited from \c M, its Value is \c bool. /// @@ -1193,7 +1193,7 @@ ///Logical 'not' of a map (ReadWrie version) - ///This bool \c concepts::ReadWriteMap "read-write map" returns the + ///This bool \ref concepts::ReadWriteMap "read-write map" returns the ///logical negation of the value returned by the given map. When it is set, ///the opposite value is set to the original map. ///Its \c Key is inherited from \c M, its Value is \c bool. @@ -1261,8 +1261,9 @@ /// \brief Writable bool map for logging each \c true assigned element /// - /// Writable bool map for logging each \c true assigned element, i.e it - /// copies all the keys set to \c true to the given iterator. + /// A \ref concepts::ReadWriteMap "read-write" bool map for logging + /// each \c true assigned element, i.e it/ copies all the keys set + /// to \c true to the given iterator. /// /// \note The container of the iterator should contain space /// for each element.