Changeset 825:75e6020b19b1 in lemon-1.2 for lemon/preflow.h

Timestamp:

02/12/10 11:00:20 (14 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Add doc for the traits class parameters (#315)

File:

• lemon/preflow.h (modified) (1 diff)

lemon/preflow.h

@@ -120 +120 @@
   /// \tparam CAP The type of the capacity map. The default map
   /// type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
+  /// \tparam TR The traits class that defines various types used by the
+  /// algorithm. By default, it is \ref PreflowDefaultTraits
+  /// "PreflowDefaultTraits<GR, CAP>".
+  /// In most cases, this parameter should not be set directly,
+  /// consider to use the named template parameters instead.
 #ifdef DOXYGEN
   template <typename GR, typename CAP, typename TR>