[Lemon-commits] Alpar Juttner: Minor doc fixes

[Lemon HG]

details:   http://lemon.cs.elte.hu/hg/lemon/rev/760a5f690163
changeset: 1353:760a5f690163
user:      Alpar Juttner <alpar [at] cs.elte.hu>
date:      Fri May 15 10:15:30 2015 +0200
description:
	Minor doc fixes

diffstat:

 lemon/lp_base.h |  10 ++++++----
 lemon/vf2.h     |  10 ++++++----
 2 files changed, 12 insertions(+), 8 deletions(-)

diffs (87 lines):

diff --git a/lemon/lp_base.h b/lemon/lp_base.h
--- a/lemon/lp_base.h
+++ b/lemon/lp_base.h
@@ -196,6 +196,7 @@
     ///\code
     /// for(auto c: lp.cols())
     ///   doSomething(c);
+    ///\endcode
     LemonRangeWrapper1<ColIt, LpBase> cols() {
       return LemonRangeWrapper1<ColIt, LpBase>(*this);
     }
@@ -306,6 +307,7 @@
     ///\code
     /// for(auto c: lp.rows())
     ///   doSomething(c);
+    ///\endcode
     LemonRangeWrapper1<RowIt, LpBase> rows() {
       return LemonRangeWrapper1<RowIt, LpBase>(*this);
     }
@@ -657,7 +659,7 @@
 
     ///This data structure represents a column of the matrix,
     ///thas is it strores a linear expression of the dual variables
-    ///(\ref Row "Row"s).
+    ///(\ref LpBase::Row "Row"s).
     ///
     ///There are several ways to access and modify the contents of this
     ///container.
@@ -674,7 +676,7 @@
     ///\endcode
     ///(This code computes the sum of all coefficients).
     ///- Numbers (<tt>double</tt>'s)
-    ///and variables (\ref Row "Row"s) directly convert to an
+    ///and variables (\ref LpBase::Row "Row"s) directly convert to an
     ///\ref DualExpr and the usual linear operations are defined, so
     ///\code
     ///v+w
@@ -1186,13 +1188,13 @@
     ///its elements with new row (i.e. variables)
     ///\param t can be
     ///- a standard STL compatible iterable container with
-    ///\ref Row as its \c values_type like
+    ///\ref LpBase::Row "Row" as its \c values_type like
     ///\code
     ///std::vector<LpBase::Row>
     ///std::list<LpBase::Row>
     ///\endcode
     ///- a standard STL compatible iterable container with
-    ///\ref Row as its \c mapped_type like
+    ///\ref LpBase::Row "Row" as its \c mapped_type like
     ///\code
     ///std::map<AnyType,LpBase::Row>
     ///\endcode
diff --git a/lemon/vf2.h b/lemon/vf2.h
--- a/lemon/vf2.h
+++ b/lemon/vf2.h
@@ -425,7 +425,7 @@
     ///
     ///The mapping type is set to \ref SUBGRAPH by default.
     ///
-    ///\sa See \ref for the possible values.
+    ///\sa See \ref Vf2MappingType for the possible values.
     void mappingType(Vf2MappingType m_type) { _mapping_type = m_type; }
 
     ///Find a mapping
@@ -561,8 +561,10 @@
     ///\ref named-templ-param "Named parameter" function for setting
     ///the node labels defining equivalence relation between them.
     ///
-    ///\param m1 It is arbitrary \ref ReadMap "readable node map" of g1.
-    ///\param m1 It is arbitrary \ref ReadMap "readable node map" of g2.
+    ///\param m1 It is arbitrary \ref concepts::ReadMap "readable node map"
+    ///of g1.
+    ///\param m2 It is arbitrary \ref concepts::ReadMap "readable node map"
+    ///of g2.
     ///
     ///The value type of these maps must be equal comparable.
     template<class M1, class M2>
@@ -580,7 +582,7 @@
     ///
     ///The mapping type is set to \ref SUBGRAPH by default.
     ///
-    ///\sa See \ref for the possible values.
+    ///\sa See \ref Vf2MappingType for the possible values.
     Vf2Wizard<Base> &mappingType(Vf2MappingType m_type)
     {
       _mapping_type = m_type;