Minor doc fixes
authorAlpar Juttner <alpar@cs.elte.hu>
Fri, 15 May 2015 10:15:30 +0200
changeset 1144760a5f690163
parent 1143 f85ee41c84bc
child 1145 1de908281369
Minor doc fixes
lemon/lp_base.h
lemon/vf2.h
     1.1 --- a/lemon/lp_base.h	Thu May 14 17:13:44 2015 +0200
     1.2 +++ b/lemon/lp_base.h	Fri May 15 10:15:30 2015 +0200
     1.3 @@ -196,6 +196,7 @@
     1.4      ///\code
     1.5      /// for(auto c: lp.cols())
     1.6      ///   doSomething(c);
     1.7 +    ///\endcode
     1.8      LemonRangeWrapper1<ColIt, LpBase> cols() {
     1.9        return LemonRangeWrapper1<ColIt, LpBase>(*this);
    1.10      }
    1.11 @@ -306,6 +307,7 @@
    1.12      ///\code
    1.13      /// for(auto c: lp.rows())
    1.14      ///   doSomething(c);
    1.15 +    ///\endcode
    1.16      LemonRangeWrapper1<RowIt, LpBase> rows() {
    1.17        return LemonRangeWrapper1<RowIt, LpBase>(*this);
    1.18      }
    1.19 @@ -657,7 +659,7 @@
    1.20  
    1.21      ///This data structure represents a column of the matrix,
    1.22      ///thas is it strores a linear expression of the dual variables
    1.23 -    ///(\ref Row "Row"s).
    1.24 +    ///(\ref LpBase::Row "Row"s).
    1.25      ///
    1.26      ///There are several ways to access and modify the contents of this
    1.27      ///container.
    1.28 @@ -674,7 +676,7 @@
    1.29      ///\endcode
    1.30      ///(This code computes the sum of all coefficients).
    1.31      ///- Numbers (<tt>double</tt>'s)
    1.32 -    ///and variables (\ref Row "Row"s) directly convert to an
    1.33 +    ///and variables (\ref LpBase::Row "Row"s) directly convert to an
    1.34      ///\ref DualExpr and the usual linear operations are defined, so
    1.35      ///\code
    1.36      ///v+w
    1.37 @@ -1186,13 +1188,13 @@
    1.38      ///its elements with new row (i.e. variables)
    1.39      ///\param t can be
    1.40      ///- a standard STL compatible iterable container with
    1.41 -    ///\ref Row as its \c values_type like
    1.42 +    ///\ref LpBase::Row "Row" as its \c values_type like
    1.43      ///\code
    1.44      ///std::vector<LpBase::Row>
    1.45      ///std::list<LpBase::Row>
    1.46      ///\endcode
    1.47      ///- a standard STL compatible iterable container with
    1.48 -    ///\ref Row as its \c mapped_type like
    1.49 +    ///\ref LpBase::Row "Row" as its \c mapped_type like
    1.50      ///\code
    1.51      ///std::map<AnyType,LpBase::Row>
    1.52      ///\endcode
     2.1 --- a/lemon/vf2.h	Thu May 14 17:13:44 2015 +0200
     2.2 +++ b/lemon/vf2.h	Fri May 15 10:15:30 2015 +0200
     2.3 @@ -425,7 +425,7 @@
     2.4      ///
     2.5      ///The mapping type is set to \ref SUBGRAPH by default.
     2.6      ///
     2.7 -    ///\sa See \ref for the possible values.
     2.8 +    ///\sa See \ref Vf2MappingType for the possible values.
     2.9      void mappingType(Vf2MappingType m_type) { _mapping_type = m_type; }
    2.10  
    2.11      ///Find a mapping
    2.12 @@ -561,8 +561,10 @@
    2.13      ///\ref named-templ-param "Named parameter" function for setting
    2.14      ///the node labels defining equivalence relation between them.
    2.15      ///
    2.16 -    ///\param m1 It is arbitrary \ref ReadMap "readable node map" of g1.
    2.17 -    ///\param m1 It is arbitrary \ref ReadMap "readable node map" of g2.
    2.18 +    ///\param m1 It is arbitrary \ref concepts::ReadMap "readable node map"
    2.19 +    ///of g1.
    2.20 +    ///\param m2 It is arbitrary \ref concepts::ReadMap "readable node map"
    2.21 +    ///of g2.
    2.22      ///
    2.23      ///The value type of these maps must be equal comparable.
    2.24      template<class M1, class M2>
    2.25 @@ -580,7 +582,7 @@
    2.26      ///
    2.27      ///The mapping type is set to \ref SUBGRAPH by default.
    2.28      ///
    2.29 -    ///\sa See \ref for the possible values.
    2.30 +    ///\sa See \ref Vf2MappingType for the possible values.
    2.31      Vf2Wizard<Base> &mappingType(Vf2MappingType m_type)
    2.32      {
    2.33        _mapping_type = m_type;