Changeset - r252:66644b9cd9eb
« 249:f0b89f
254:43500a »
gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Doc improvement for visitor classes (ticket #134)
0 2 0
default
2 files changed with 10 insertions and 0 deletions:
lemon/bfs.h
5
lemon/dfs.h
5
↑ Collapse diff ↑
lemon/bfs.h
Ignore white space 12 line context
... ... 
@@ -1259,12 +1259,17 @@
1259 1259 
  /// with visitor interface.
1260 1260 
  ///
1261 1261 
  /// The %BfsVisit class provides an alternative interface to the Bfs
1262 1262 
  /// class. It works with callback mechanism, the BfsVisit object calls
1263 1263 
  /// the member functions of the \c Visitor class on every BFS event.
1264 1264 
  ///
1265 
  /// This interface of the BFS algorithm should be used in special cases
1266 
  /// when extra actions have to be performed in connection with certain
1267 
  /// events of the BFS algorithm. Otherwise consider to use Bfs or bfs()
1268 
  /// instead.
1269 
  ///
1265 1270 
  /// \tparam _Digraph The type of the digraph the algorithm runs on.
1266 1271 
  /// The default value is
1267 1272 
  /// \ref ListDigraph. The value of _Digraph is not used directly by
1268 1273 
  /// \ref BfsVisit, it is only passed to \ref BfsVisitDefaultTraits.
1269 1274 
  /// \tparam _Visitor The Visitor type that is used by the algorithm.
1270 1275 
  /// \ref BfsVisitor "BfsVisitor<_Digraph>" is an empty visitor, which
lemon/dfs.h
Ignore white space 12 line context
... ... 
@@ -1206,12 +1206,17 @@
1206 1206 
  /// with visitor interface.
1207 1207 
  ///
1208 1208 
  /// The %DfsVisit class provides an alternative interface to the Dfs
1209 1209 
  /// class. It works with callback mechanism, the DfsVisit object calls
1210 1210 
  /// the member functions of the \c Visitor class on every DFS event.
1211 1211 
  ///
1212 
  /// This interface of the DFS algorithm should be used in special cases
1213 
  /// when extra actions have to be performed in connection with certain
1214 
  /// events of the DFS algorithm. Otherwise consider to use Dfs or dfs()
1215 
  /// instead.
1216 
  ///
1212 1217 
  /// \tparam _Digraph The type of the digraph the algorithm runs on.
1213 1218 
  /// The default value is
1214 1219 
  /// \ref ListDigraph. The value of _Digraph is not used directly by
1215 1220 
  /// \ref DfsVisit, it is only passed to \ref DfsVisitDefaultTraits.
1216 1221 
  /// \tparam _Visitor The Visitor type that is used by the algorithm.
1217 1222 
  /// \ref DfsVisitor "DfsVisitor<_Digraph>" is an empty visitor, which
0 comments (0 inline)