Doc improvement for visitor classes (ticket #134)
authorPeter Kovacs <kpeter@inf.elte.hu>
Sat, 30 Aug 2008 22:29:08 +0200
changeset 25266644b9cd9eb
parent 249 f0b89f242745
child 254 43500afd5cb0
Doc improvement for visitor classes (ticket #134)
lemon/bfs.h
lemon/dfs.h
     1.1 --- a/lemon/bfs.h	Mon Aug 18 20:33:11 2008 +0200
     1.2 +++ b/lemon/bfs.h	Sat Aug 30 22:29:08 2008 +0200
     1.3 @@ -1262,6 +1262,11 @@
     1.4    /// class. It works with callback mechanism, the BfsVisit object calls
     1.5    /// the member functions of the \c Visitor class on every BFS event.
     1.6    ///
     1.7 +  /// This interface of the BFS algorithm should be used in special cases
     1.8 +  /// when extra actions have to be performed in connection with certain
     1.9 +  /// events of the BFS algorithm. Otherwise consider to use Bfs or bfs()
    1.10 +  /// instead.
    1.11 +  ///
    1.12    /// \tparam _Digraph The type of the digraph the algorithm runs on.
    1.13    /// The default value is
    1.14    /// \ref ListDigraph. The value of _Digraph is not used directly by
     2.1 --- a/lemon/dfs.h	Mon Aug 18 20:33:11 2008 +0200
     2.2 +++ b/lemon/dfs.h	Sat Aug 30 22:29:08 2008 +0200
     2.3 @@ -1209,6 +1209,11 @@
     2.4    /// class. It works with callback mechanism, the DfsVisit object calls
     2.5    /// the member functions of the \c Visitor class on every DFS event.
     2.6    ///
     2.7 +  /// This interface of the DFS algorithm should be used in special cases
     2.8 +  /// when extra actions have to be performed in connection with certain
     2.9 +  /// events of the DFS algorithm. Otherwise consider to use Dfs or dfs()
    2.10 +  /// instead.
    2.11 +  ///
    2.12    /// \tparam _Digraph The type of the digraph the algorithm runs on.
    2.13    /// The default value is
    2.14    /// \ref ListDigraph. The value of _Digraph is not used directly by