Changeset 269:f5965bbf1353 in lemon-main for doc

Timestamp:

09/21/08 18:09:47 (16 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Improvements in named-param.dox (ticket #147)

File:

• doc/named-param.dox (modified) (7 diffs)

doc/named-param.dox

@@ -1 @@
-/* -*- C++ -*-
+/* -*- mode: C++; indent-tabs-mode: nil; -*-
  *
- * This file is a part of LEMON, a generic C++ optimization library
+ * This file is a part of LEMON, a generic C++ optimization library.
  *
  * Copyright (C) 2003-2008
@@ -26 +26 @@
 function parameters by name also when you call the function. It is
 especially comfortable in case of a function having tons of parameters
-with natural default values. Sadly, C++ lack this amenity. 
+with natural default values. Sadly, C++ lack this amenity.
 
 However, with a crafty trick and with some little
@@ -33 +33 @@
 
 \code
-class namedFn 
+class namedFn
 {
   int _id;
   double _val;
   int _dim;
-  
+
   public:
   namedFn() : _id(0), _val(1), _dim(2) {}
@@ -46 +46 @@
 
   run() {
-  std::cout << "Here comes the function itself\n" <<
-            << "With parameters "
-            << _id << ", " << _val << ", " << _dim << std::endl; 
+    std::cout << "Here comes the function itself\n" <<
+              << "With parameters "
+              << _id << ", " << _val << ", " << _dim << std::endl;
   }
 };
@@ -77 +77 @@
 \section named-templ-func-param Named Function Template Parameters
 
-A named parameter can also be a template functions. The usage is
+A named parameter can also be a template function. The usage is
 exactly the same, but the implementation behind is a kind of black
 magic and they are the dirtiest part of the LEMON code.
@@ -104 +104 @@
 
 \code
-Dijkstra<>::SetPredNodeMap<NullMap<Node,Node> >::Create
+Dijkstra<>::SetPredMap<NullMap<Node,Arc> >::Create
 \endcode
 
@@ -111 +111 @@
 
 \code
-Dijkstra<>::SetDistMap<MyMap>::SetPredMap<NullMap<Node,Edge> >::Create
+Dijkstra<>::SetDistMap<MyMap>::SetPredMap<NullMap<Node,Arc> >::Create
 \endcode