COIN-OR::LEMON - Graph Library

Changeset 46:b6dd98b57d71 in lemon


Ignore:
Timestamp:
01/07/08 23:57:48 (11 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Minor doc fixes.
Replaced \c by \ref and \ref by \c to work properly and to be uniform.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/maps.h

    r45 r46  
    159159  }
    160160
    161   ///Map based on std::map
     161  ///Map based on \c std::map
    162162
    163163  ///This is essentially a wrapper for \c std::map with addition that
     
    243243  };
    244244 
    245   ///Returns a \ref StdMap class
    246 
    247   ///This function just returns a \ref StdMap class with specified
     245  ///Returns a \c StdMap class
     246
     247  ///This function just returns a \c StdMap class with specified
    248248  ///default value.
    249249  ///\relates StdMap
     
    253253  }
    254254
    255   ///Returns a \ref StdMap class created from an appropriate std::map
    256 
    257   ///This function just returns a \ref StdMap class created from an
     255  ///Returns a \c StdMap class created from an appropriate std::map
     256
     257  ///This function just returns a \c StdMap class created from an
    258258  ///appropriate std::map.
    259259  ///\relates StdMap
     
    340340  };
    341341 
    342   ///Returns an \ref IntegerMap class
    343 
    344   ///This function just returns an \ref IntegerMap class.
     342  ///Returns an \c IntegerMap class
     343
     344  ///This function just returns an \c IntegerMap class.
    345345  ///\relates IntegerMap
    346346  template<typename T>
     
    384384  ///the default conversion.
    385385  ///
    386   ///This \c concepts::ReadMap "read only map"
     386  ///This \ref concepts::ReadMap "read only map"
    387387  ///converts the \c Value of a map to type \c T.
    388388  ///Its \c Key is inherited from \c M.
     
    441441  };
    442442 
    443   ///Returns a \ref SimpleMap class
    444 
    445   ///This function just returns a \ref SimpleMap class.
     443  ///Returns a \c SimpleMap class
     444
     445  ///This function just returns a \c SimpleMap class.
    446446  ///\relates SimpleMap
    447447  template<typename M>
     
    452452  ///Simple writable wrapping of a map
    453453
    454   ///This \ref concepts::WriteMap "write map" returns the simple
     454  ///This \ref concepts::ReadWriteMap "read-write map" returns the simple
    455455  ///wrapping of the given map. Sometimes the reference maps cannot be
    456456  ///combined with simple read-write maps. This map adaptor wraps the
     
    477477  };
    478478
    479   ///Returns a \ref SimpleWriteMap class
    480 
    481   ///This function just returns a \ref SimpleWriteMap class.
     479  ///Returns a \c SimpleWriteMap class
     480
     481  ///This function just returns a \c SimpleWriteMap class.
    482482  ///\relates SimpleWriteMap
    483483  template<typename M>
     
    488488  ///Sum of two maps
    489489
    490   ///This \c concepts::ReadMap "read only map" returns the sum of the two
     490  ///This \ref concepts::ReadMap "read only map" returns the sum of the two
    491491  ///given maps.
    492492  ///Its \c Key and \c Value are inherited from \c M1.
     
    521521  ///Shift a map with a constant.
    522522
    523   ///This \c concepts::ReadMap "read only map" returns the sum of the
     523  ///This \ref concepts::ReadMap "read only map" returns the sum of the
    524524  ///given map and a constant value.
    525525  ///Its \c Key and \c Value are inherited from \c M.
     
    557557  ///Shift a map with a constant (ReadWrite version).
    558558
    559   ///This \c concepts::ReadWriteMap "read-write map" returns the sum of the
     559  ///This \ref concepts::ReadWriteMap "read-write map" returns the sum of the
    560560  ///given map and a constant value. It makes also possible to write the map.
    561561  ///Its \c Key and \c Value are inherited from \c M.
     
    603603  ///Difference of two maps
    604604
    605   ///This \c concepts::ReadMap "read only map" returns the difference
     605  ///This \ref concepts::ReadMap "read only map" returns the difference
    606606  ///of the values of the two given maps.
    607607  ///Its \c Key and \c Value are inherited from \c M1.
     
    636636  ///Product of two maps
    637637
    638   ///This \c concepts::ReadMap "read only map" returns the product of the
     638  ///This \ref concepts::ReadMap "read only map" returns the product of the
    639639  ///values of the two given maps.
    640640  ///Its \c Key and \c Value are inherited from \c M1.
     
    666666  ///Scales a map with a constant.
    667667
    668   ///This \c concepts::ReadMap "read only map" returns the value of the
     668  ///This \ref concepts::ReadMap "read only map" returns the value of the
    669669  ///given map multiplied from the left side with a constant value.
    670670  ///Its \c Key and \c Value are inherited from \c M.
     
    702702  ///Scales a map with a constant (ReadWrite version).
    703703
    704   ///This \c concepts::ReadWriteMap "read-write map" returns the value of the
     704  ///This \ref concepts::ReadWriteMap "read-write map" returns the value of the
    705705  ///given map multiplied from the left side with a constant value. It can
    706706  ///also be used as write map if the \c / operator is defined between
     
    750750  ///Quotient of two maps
    751751
    752   ///This \c concepts::ReadMap "read only map" returns the quotient of the
     752  ///This \ref concepts::ReadMap "read only map" returns the quotient of the
    753753  ///values of the two given maps.
    754754  ///Its \c Key and \c Value are inherited from \c M1.
     
    780780  ///Composition of two maps
    781781
    782   ///This \c concepts::ReadMap "read only map" returns the composition of
     782  ///This \ref concepts::ReadMap "read only map" returns the composition of
    783783  ///two given maps.
    784784  ///That is to say, if \c m1 is of type \c M1 and \c m2 is of \c M2,
     
    831831  ///Combine of two maps using an STL (binary) functor.
    832832  ///
    833   ///This \c concepts::ReadMap "read only map" takes two maps and a
     833  ///This \ref concepts::ReadMap "read only map" takes two maps and a
    834834  ///binary functor and returns the composition of the two
    835835  ///given maps unsing the functor.
     
    904904  ///Negative value of a map
    905905
    906   ///This \c concepts::ReadMap "read only map" returns the negative
     906  ///This \ref concepts::ReadMap "read only map" returns the negative
    907907  ///value of the value returned by the given map.
    908908  ///Its \c Key and \c Value are inherited from \c M.
     
    926926  ///Negative value of a map (ReadWrite version)
    927927
    928   ///This \c concepts::ReadWriteMap "read-write map" returns the negative
     928  ///This \ref concepts::ReadWriteMap "read-write map" returns the negative
    929929  ///value of the value returned by the given map.
    930930  ///Its \c Key and \c Value are inherited from \c M.
     
    968968  ///Absolute value of a map
    969969
    970   ///This \c concepts::ReadMap "read only map" returns the absolute value
     970  ///This \ref concepts::ReadMap "read only map" returns the absolute value
    971971  ///of the value returned by the given map.
    972972  ///Its \c Key and \c Value are inherited from \c M.
     
    10021002  ///Converts an STL style functor to a map
    10031003
    1004   ///This \c concepts::ReadMap "read only map" returns the value
     1004  ///This \ref concepts::ReadMap "read only map" returns the value
    10051005  ///of a given functor.
    10061006  ///
     
    10601060  ///
    10611061  ///For the sake of convenience it also works as
    1062   ///a ususal \c concepts::ReadMap "readable map",
     1062  ///a ususal \ref concepts::ReadMap "readable map",
    10631063  ///i.e. <tt>operator[]</tt> and the \c Key and \c Value typedefs also exist.
    10641064  ///
     
    10941094  ///Applies all map setting operations to two maps
    10951095
    1096   ///This map has two \c concepts::ReadMap "readable map"
     1096  ///This map has two \ref concepts::ReadMap "readable map"
    10971097  ///parameters and each read request will be passed just to the
    1098   ///first map. This class is the just readable map type of the ForkWriteMap.
     1098  ///first map. This class is the just readable map type of the \c ForkWriteMap.
    10991099  ///
    11001100  ///The \c Key and \c Value are inherited from \c M1.
     
    11221122  ///Applies all map setting operations to two maps
    11231123
    1124   ///This map has two \c concepts::WriteMap "writable map"
     1124  ///This map has two \ref concepts::WriteMap "writable map"
    11251125  ///parameters and each write request will be passed to both of them.
    1126   ///If \c M1 is also \c concepts::ReadMap "readable",
     1126  ///If \c M1 is also \ref concepts::ReadMap "readable",
    11271127  ///then the read operations will return the
    11281128  ///corresponding values of \c M1.
     
    11731173  ///Logical 'not' of a map
    11741174 
    1175   ///This bool \c concepts::ReadMap "read only map" returns the
     1175  ///This bool \ref concepts::ReadMap "read only map" returns the
    11761176  ///logical negation of the value returned by the given map.
    11771177  ///Its \c Key is inherited from \c M, its Value is \c bool.
     
    11941194  ///Logical 'not' of a map (ReadWrie version)
    11951195 
    1196   ///This bool \c concepts::ReadWriteMap "read-write map" returns the
     1196  ///This bool \ref concepts::ReadWriteMap "read-write map" returns the
    11971197  ///logical negation of the value returned by the given map. When it is set,
    11981198  ///the opposite value is set to the original map.
     
    12621262  /// \brief Writable bool map for logging each \c true assigned element
    12631263  ///
    1264   /// Writable bool map for logging each \c true assigned element, i.e it
    1265   /// copies all the keys set to \c true to the given iterator.
     1264  /// A \ref concepts::ReadWriteMap "read-write" bool map for logging
     1265  /// each \c true assigned element, i.e it/ copies all the keys set
     1266  /// to \c true to the given iterator.
    12661267  ///
    12671268  /// \note The container of the iterator should contain space
Note: See TracChangeset for help on using the changeset viewer.