Index: lemon/maps.h =================================================================== --- lemon/maps.h (revision 45) +++ lemon/maps.h (revision 46) @@ -159,5 +159,5 @@ } - ///Map based on std::map + ///Map based on \c std::map ///This is essentially a wrapper for \c std::map with addition that @@ -243,7 +243,7 @@ }; - ///Returns a \ref StdMap class - - ///This function just returns a \ref StdMap class with specified + ///Returns a \c StdMap class + + ///This function just returns a \c StdMap class with specified ///default value. ///\relates StdMap @@ -253,7 +253,7 @@ } - ///Returns a \ref StdMap class created from an appropriate std::map - - ///This function just returns a \ref StdMap class created from an + ///Returns a \c StdMap class created from an appropriate std::map + + ///This function just returns a \c StdMap class created from an ///appropriate std::map. ///\relates StdMap @@ -340,7 +340,7 @@ }; - ///Returns an \ref IntegerMap class - - ///This function just returns an \ref IntegerMap class. + ///Returns an \c IntegerMap class + + ///This function just returns an \c IntegerMap class. ///\relates IntegerMap template @@ -384,5 +384,5 @@ ///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. @@ -441,7 +441,7 @@ }; - ///Returns a \ref SimpleMap class - - ///This function just returns a \ref SimpleMap class. + ///Returns a \c SimpleMap class + + ///This function just returns a \c SimpleMap class. ///\relates SimpleMap template @@ -452,5 +452,5 @@ ///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 @@ -477,7 +477,7 @@ }; - ///Returns a \ref SimpleWriteMap class - - ///This function just returns a \ref SimpleWriteMap class. + ///Returns a \c SimpleWriteMap class + + ///This function just returns a \c SimpleWriteMap class. ///\relates SimpleWriteMap template @@ -488,5 +488,5 @@ ///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. @@ -521,5 +521,5 @@ ///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. @@ -557,5 +557,5 @@ ///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. @@ -603,5 +603,5 @@ ///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. @@ -636,5 +636,5 @@ ///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. @@ -666,5 +666,5 @@ ///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. @@ -702,5 +702,5 @@ ///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 @@ -750,5 +750,5 @@ ///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. @@ -780,5 +780,5 @@ ///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, @@ -831,5 +831,5 @@ ///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. @@ -904,5 +904,5 @@ ///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. @@ -926,5 +926,5 @@ ///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. @@ -968,5 +968,5 @@ ///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. @@ -1002,5 +1002,5 @@ ///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. /// @@ -1060,5 +1060,5 @@ /// ///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. /// @@ -1094,7 +1094,7 @@ ///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. @@ -1122,7 +1122,7 @@ ///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. @@ -1173,5 +1173,5 @@ ///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. @@ -1194,5 +1194,5 @@ ///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. @@ -1262,6 +1262,7 @@ /// \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