Changeset 1144:760a5f690163 in lemon-main

Timestamp:

05/15/15 10:15:30 (10 years ago)

Author:

Alpar Juttner <alpar@…>

Branch:

default

Phase:

public

Message:

Minor doc fixes

Location:

lemon

Files:

• lp_base.h (modified) (6 diffs)
• vf2.h (modified) (3 diffs)

lemon/lp_base.h

@@ -197 +197 @@
     /// for(auto c: lp.cols())
     ///   doSomething(c);
+    ///\endcode
     LemonRangeWrapper1<ColIt, LpBase> cols() {
       return LemonRangeWrapper1<ColIt, LpBase>(*this);
@@ -307 +308 @@
     /// for(auto c: lp.rows())
     ///   doSomething(c);
+    ///\endcode
     LemonRangeWrapper1<RowIt, LpBase> rows() {
       return LemonRangeWrapper1<RowIt, LpBase>(*this);
@@ -658 +660 @@
     ///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
@@ -675 +677 @@
     ///(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
@@ -1187 +1189 @@
     ///\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>
@@ -1193 +1195 @@
     ///\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>

lemon/vf2.h

@@ -426 +426 @@
     ///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; }
 
@@ -562 +562 @@
     ///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.
@@ -581 +583 @@
     ///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)
     {