[Lemon-commits] Peter Kovacs: Doc improvement for visitor classe...

[Lemon HG]

details:   http://lemon.cs.elte.hu/hg/lemon/rev/66644b9cd9eb
changeset: 252:66644b9cd9eb
user:      Peter Kovacs <kpeter [at] inf.elte.hu>
date:      Sat Aug 30 22:29:08 2008 +0200
description:
	Doc improvement for visitor classes (ticket #134)

diffstat:

2 files changed, 10 insertions(+)
lemon/bfs.h |    5 +++++
lemon/dfs.h |    5 +++++

diffs (30 lines):

diff -r f0b89f242745 -r 66644b9cd9eb lemon/bfs.h
--- a/lemon/bfs.h	Mon Aug 18 20:33:11 2008 +0200
+++ b/lemon/bfs.h	Sat Aug 30 22:29:08 2008 +0200
@@ -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 -r f0b89f242745 -r 66644b9cd9eb lemon/dfs.h
--- a/lemon/dfs.h	Mon Aug 18 20:33:11 2008 +0200
+++ b/lemon/dfs.h	Sat Aug 30 22:29:08 2008 +0200
@@ -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