# HG changeset patch # User Peter Kovacs # Date 2008-08-30 22:29:08 # Node ID 66644b9cd9ebca91a7267b7b0aeefcfc490327d4 # Parent f0b89f24274560f96db7740ebb807719f5e5e369 Doc improvement for visitor classes (ticket #134) diff --git a/lemon/bfs.h b/lemon/bfs.h --- a/lemon/bfs.h +++ b/lemon/bfs.h @@ -1262,6 +1262,11 @@ /// class. It works with callback mechanism, the BfsVisit object calls /// 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 /// \ref ListDigraph. The value of _Digraph is not used directly by diff --git a/lemon/dfs.h b/lemon/dfs.h --- a/lemon/dfs.h +++ b/lemon/dfs.h @@ -1209,6 +1209,11 @@ /// class. It works with callback mechanism, the DfsVisit object calls /// 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 /// \ref ListDigraph. The value of _Digraph is not used directly by