Changeset 2370:ed6539025f27 in lemon-0.x for lemon/lp_utils.h

Timestamp:

02/19/07 19:56:11 (17 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3185

Message:

Some documentation changes

File:

• lemon/lp_utils.h (modified) (8 diffs)

lemon/lp_utils.h

@@ -31 +31 @@
 namespace lemon {
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
   ///
   /// \brief The map for the result of the lp variables.
@@ -52 +52 @@
   };
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
+  ///
+  /// \brief Returns an \ref LpResultMap class
+  ///
+  /// This function just returns an \ref LpResultMap class.
+  /// \relates LpResultMap
+  LpResultMap lpResultMap(const LpSolverBase& lp) {
+    return LpResultMap(lp);
+  }
+
+  /// \ingroup lp_utils
   ///
   /// \brief The map for the name of the lp variables.
@@ -73 +83 @@
   };
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
   ///
   /// \brief Writeable map for the name of the lp variables.
@@ -97 +107 @@
   };
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
   ///
   /// \brief Returns an \ref LpColNameMap class
@@ -111 +121 @@
   }
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
   ///
   /// \brief Lp variable item reader for Lemon IO
@@ -198 +208 @@
   };
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
   ///
   /// \brief Lp variable item writer for Lemon IO
@@ -264 +274 @@
   };
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
   ///
   /// \brief Lp section reader for lemon IO
@@ -744 +754 @@
 
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
   ///
   /// \brief Lp section writer for lemon IO