Changeset 252:66644b9cd9eb in lemon-main

Timestamp:

08/30/08 22:29:08 (16 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Doc improvement for visitor classes (ticket #134)

Location:

lemon

Files:

• bfs.h (modified) (1 diff)
• dfs.h (modified) (1 diff)

lemon/bfs.h

@@ -1263 +1263 @@
   /// the member functions of the \c Visitor class on every BFS event.
   ///
+  /// This interface of the BFS algorithm should be used in special cases
+  /// when extra actions have to be performed in connection with certain
+  /// events of the BFS algorithm. Otherwise consider to use Bfs or bfs()
+  /// instead.
+  ///
   /// \tparam _Digraph The type of the digraph the algorithm runs on.
   /// The default value is

lemon/dfs.h

@@ -1210 +1210 @@
   /// the member functions of the \c Visitor class on every DFS event.
   ///
+  /// This interface of the DFS algorithm should be used in special cases
+  /// when extra actions have to be performed in connection with certain
+  /// events of the DFS algorithm. Otherwise consider to use Dfs or dfs()
+  /// instead.
+  ///
   /// \tparam _Digraph The type of the digraph the algorithm runs on.
   /// The default value is