1.1 --- a/demo/graph_to_eps_demo.cc Wed Oct 08 17:05:01 2008 +0100
1.2 +++ b/demo/graph_to_eps_demo.cc Thu Oct 09 10:09:44 2008 +0200
1.3 @@ -26,7 +26,7 @@
1.4 /// graphToEps(), and showing how to draw directed graphs,
1.5 /// how to handle parallel egdes, how to change the properties (like
1.6 /// color, shape, size, title etc.) of nodes and arcs individually
1.7 -/// using appropriate \ref maps-page "graph maps".
1.8 +/// using appropriate graph maps.
1.9 ///
1.10 /// \include graph_to_eps_demo.cc
1.11
2.1 --- a/doc/lgf.dox Wed Oct 08 17:05:01 2008 +0100
2.2 +++ b/doc/lgf.dox Thu Oct 09 10:09:44 2008 +0200
2.3 @@ -78,7 +78,7 @@
2.4 2 3 18
2.5 \endcode
2.6
2.7 -The \c \@edges is just a synonym of \c \@arcs. The @arcs section can
2.8 +The \c \@edges is just a synonym of \c \@arcs. The \@arcs section can
2.9 also store the edge set of an undirected graph. In such case there is
2.10 a conventional method for store arc maps in the file, if two columns
2.11 has the same caption with \c '+' and \c '-' prefix, then these columns
3.1 --- a/lemon/bits/alteration_notifier.h Wed Oct 08 17:05:01 2008 +0100
3.2 +++ b/lemon/bits/alteration_notifier.h Thu Oct 09 10:09:44 2008 +0200
3.3 @@ -79,8 +79,7 @@
3.4 /// observeres will not be notified and the fulfilled additions will
3.5 /// be rolled back by calling the \e erase() or \e clear()
3.6 /// functions. Thence the \e erase() and \e clear() should not throw
3.7 - /// exception. Actullay, it can be throw only
3.8 - /// \ref AlterationObserver::ImmediateDetach ImmediateDetach
3.9 + /// exception. Actullay, it can be throw only \ref ImmediateDetach
3.10 /// exception which detach the observer from the notifier.
3.11 ///
3.12 /// There are some place when the alteration observing is not completly
4.1 --- a/lemon/bits/default_map.h Wed Oct 08 17:05:01 2008 +0100
4.2 +++ b/lemon/bits/default_map.h Thu Oct 09 10:09:44 2008 +0200
4.3 @@ -149,7 +149,7 @@
4.4
4.5 // #endif
4.6
4.7 - /// \e
4.8 + /// DefaultMap class
4.9 template <typename _Graph, typename _Item, typename _Value>
4.10 class DefaultMap
4.11 : public DefaultMapSelector<_Graph, _Item, _Value>::Map {
5.1 --- a/lemon/color.h Wed Oct 08 17:05:01 2008 +0100
5.2 +++ b/lemon/color.h Thu Oct 09 10:09:44 2008 +0200
5.3 @@ -92,7 +92,7 @@
5.4 /// Dark cyan color constant
5.5 extern const Color DARK_CYAN;
5.6
5.7 - ///Map <tt>int</tt>s to different \ref Color "Color"s
5.8 + ///Map <tt>int</tt>s to different <tt>Color</tt>s
5.9
5.10 ///This map assigns one of the predefined \ref Color "Color"s to
5.11 ///each <tt>int</tt>. It is possible to change the colors as well as
6.1 --- a/lemon/concepts/graph_components.h Wed Oct 08 17:05:01 2008 +0100
6.2 +++ b/lemon/concepts/graph_components.h Thu Oct 09 10:09:44 2008 +0200
6.3 @@ -982,7 +982,7 @@
6.4 /// \brief Class describing the concept of graph maps
6.5 ///
6.6 /// This class describes the common interface of the graph maps
6.7 - /// (NodeMap, ArcMap), that is \ref maps-page "maps" which can be used to
6.8 + /// (NodeMap, ArcMap), that is maps that can be used to
6.9 /// associate data to graph descriptors (nodes or arcs).
6.10 template <typename _Graph, typename _Item, typename _Value>
6.11 class GraphMap : public ReadWriteMap<_Item, _Value> {
7.1 --- a/lemon/core.h Wed Oct 08 17:05:01 2008 +0100
7.2 +++ b/lemon/core.h Thu Oct 09 10:09:44 2008 +0200
7.3 @@ -1554,7 +1554,7 @@
7.4 ///\note This is a dynamic data structure, therefore the data
7.5 ///structure is updated after each graph alteration. Thus although
7.6 ///this data structure is theoretically faster than \ref ArcLookUp
7.7 - ///and \ref AllArcLookup, it often provides worse performance than
7.8 + ///and \ref AllArcLookUp, it often provides worse performance than
7.9 ///them.
7.10 Arc operator()(Node s, Node t, Arc p = INVALID) const {
7.11 if (p == INVALID) {
7.12 @@ -1699,8 +1699,8 @@
7.13
7.14 ///Find an arc between two nodes.
7.15
7.16 - ///Find an arc between two nodes in time <em>O</em>(log<em>d</em>), where
7.17 - ///<em>d</em> is the number of outgoing arcs of \c s.
7.18 + ///Find an arc between two nodes in time <em>O</em>(log<em>d</em>),
7.19 + ///where <em>d</em> is the number of outgoing arcs of \c s.
7.20 ///\param s The source node.
7.21 ///\param t The target node.
7.22 ///\return An arc from \c s to \c t if there exists,
7.23 @@ -1817,8 +1817,8 @@
7.24 ///for(Arc a = ae(u,v); a != INVALID; a=ae(u,v,a)) n++;
7.25 ///\endcode
7.26 ///
7.27 - ///Finding the first arc take <em>O</em>(log<em>d</em>) time, where
7.28 - ///<em>d</em> is the number of outgoing arcs of \c s. Then, the
7.29 + ///Finding the first arc take <em>O</em>(log<em>d</em>) time,
7.30 + ///where <em>d</em> is the number of outgoing arcs of \c s. Then the
7.31 ///consecutive arcs are found in constant time.
7.32 ///
7.33 ///\warning If you change the digraph, refresh() must be called before using
8.1 --- a/lemon/dfs.h Wed Oct 08 17:05:01 2008 +0100
8.2 +++ b/lemon/dfs.h Thu Oct 09 10:09:44 2008 +0200
8.3 @@ -835,7 +835,7 @@
8.4 typedef lemon::Path<Digraph> Path;
8.5 };
8.6
8.7 - /// Default traits class used by \ref DfsWizard
8.8 + /// Default traits class used by DfsWizard
8.9
8.10 /// To make it easier to use Dfs algorithm
8.11 /// we have created a wizard class.
9.1 --- a/lemon/dijkstra.h Wed Oct 08 17:05:01 2008 +0100
9.2 +++ b/lemon/dijkstra.h Thu Oct 09 10:09:44 2008 +0200
9.3 @@ -453,7 +453,7 @@
9.4 };
9.5
9.6 /// \brief \ref named-templ-param "Named parameter" for setting
9.7 - ///\ref OperationTraits type
9.8 + ///\c OperationTraits type
9.9 ///
9.10 ///\ref named-templ-param "Named parameter" for setting
9.11 ///\ref OperationTraits type.
9.12 @@ -1038,7 +1038,7 @@
9.13 typedef lemon::Path<Digraph> Path;
9.14 };
9.15
9.16 - /// Default traits class used by \ref DijkstraWizard
9.17 + /// Default traits class used by DijkstraWizard
9.18
9.19 /// To make it easier to use Dijkstra algorithm
9.20 /// we have created a wizard class.
10.1 --- a/lemon/dim2.h Wed Oct 08 17:05:01 2008 +0100
10.2 +++ b/lemon/dim2.h Thu Oct 09 10:09:44 2008 +0200
10.3 @@ -259,10 +259,10 @@
10.4
10.5
10.6
10.7 - /// Bounding box of plain vectors (\ref Point points).
10.8 + /// Bounding box of plain vectors (points).
10.9
10.10 /// A class to calculate or store the bounding box of plain vectors
10.11 - /// (\ref Point points).
10.12 + /// (\ref Point "points").
10.13 template<typename T>
10.14 class Box {
10.15 Point<T> _bottom_left, _top_right;
10.16 @@ -573,11 +573,10 @@
10.17 return os;
10.18 }
10.19
10.20 - ///Map of x-coordinates of a \ref Point "Point"-map
10.21 + ///Map of x-coordinates of a <tt>Point</tt>-map
10.22
10.23 + ///Map of x-coordinates of a \ref Point "Point"-map.
10.24 ///\ingroup maps
10.25 - ///Map of x-coordinates of a \ref Point "Point"-map.
10.26 - ///
10.27 template<class M>
10.28 class XMap
10.29 {
10.30 @@ -592,9 +591,9 @@
10.31 void set(Key k,Value v) {_map.set(k,typename M::Value(v,_map[k].y));}
10.32 };
10.33
10.34 - ///Returns an \ref XMap class
10.35 + ///Returns an XMap class
10.36
10.37 - ///This function just returns an \ref XMap class.
10.38 + ///This function just returns an XMap class.
10.39 ///
10.40 ///\ingroup maps
10.41 ///\relates XMap
10.42 @@ -610,11 +609,10 @@
10.43 return XMap<M>(m);
10.44 }
10.45
10.46 - ///Constant (read only) version of \ref XMap
10.47 + ///Constant (read only) version of XMap
10.48
10.49 + ///Constant (read only) version of XMap.
10.50 ///\ingroup maps
10.51 - ///Constant (read only) version of \ref XMap
10.52 - ///
10.53 template<class M>
10.54 class ConstXMap
10.55 {
10.56 @@ -628,9 +626,9 @@
10.57 Value operator[](Key k) const {return _map[k].x;}
10.58 };
10.59
10.60 - ///Returns a \ref ConstXMap class
10.61 + ///Returns a ConstXMap class
10.62
10.63 - ///This function just returns a \ref ConstXMap class.
10.64 + ///This function just returns a ConstXMap class.
10.65 ///
10.66 ///\ingroup maps
10.67 ///\relates ConstXMap
10.68 @@ -640,11 +638,10 @@
10.69 return ConstXMap<M>(m);
10.70 }
10.71
10.72 - ///Map of y-coordinates of a \ref Point "Point"-map
10.73 + ///Map of y-coordinates of a <tt>Point</tt>-map
10.74
10.75 + ///Map of y-coordinates of a \ref Point "Point"-map.
10.76 ///\ingroup maps
10.77 - ///Map of y-coordinates of a \ref Point "Point"-map.
10.78 - ///
10.79 template<class M>
10.80 class YMap
10.81 {
10.82 @@ -659,9 +656,9 @@
10.83 void set(Key k,Value v) {_map.set(k,typename M::Value(_map[k].x,v));}
10.84 };
10.85
10.86 - ///Returns a \ref YMap class
10.87 + ///Returns a YMap class
10.88
10.89 - ///This function just returns a \ref YMap class.
10.90 + ///This function just returns a YMap class.
10.91 ///
10.92 ///\ingroup maps
10.93 ///\relates YMap
10.94 @@ -677,11 +674,10 @@
10.95 return YMap<M>(m);
10.96 }
10.97
10.98 - ///Constant (read only) version of \ref YMap
10.99 + ///Constant (read only) version of YMap
10.100
10.101 + ///Constant (read only) version of YMap.
10.102 ///\ingroup maps
10.103 - ///Constant (read only) version of \ref YMap
10.104 - ///
10.105 template<class M>
10.106 class ConstYMap
10.107 {
10.108 @@ -695,9 +691,9 @@
10.109 Value operator[](Key k) const {return _map[k].y;}
10.110 };
10.111
10.112 - ///Returns a \ref ConstYMap class
10.113 + ///Returns a ConstYMap class
10.114
10.115 - ///This function just returns a \ref ConstYMap class.
10.116 + ///This function just returns a ConstYMap class.
10.117 ///
10.118 ///\ingroup maps
10.119 ///\relates ConstYMap
10.120 @@ -708,8 +704,7 @@
10.121 }
10.122
10.123
10.124 - ///\brief Map of the \ref Point::normSquare() "normSquare()"
10.125 - ///of a \ref Point "Point"-map
10.126 + ///\brief Map of the normSquare() of a <tt>Point</tt>-map
10.127 ///
10.128 ///Map of the \ref Point::normSquare() "normSquare()"
10.129 ///of a \ref Point "Point"-map.
10.130 @@ -727,9 +722,9 @@
10.131 Value operator[](Key k) const {return _map[k].normSquare();}
10.132 };
10.133
10.134 - ///Returns a \ref NormSquareMap class
10.135 + ///Returns a NormSquareMap class
10.136
10.137 - ///This function just returns a \ref NormSquareMap class.
10.138 + ///This function just returns a NormSquareMap class.
10.139 ///
10.140 ///\ingroup maps
10.141 ///\relates NormSquareMap
11.1 --- a/lemon/graph_to_eps.h Wed Oct 08 17:05:01 2008 +0100
11.2 +++ b/lemon/graph_to_eps.h Thu Oct 09 10:09:44 2008 +0200
11.3 @@ -62,7 +62,7 @@
11.4 };
11.5 }
11.6
11.7 -///Default traits class of \ref GraphToEps
11.8 +///Default traits class of GraphToEps
11.9
11.10 ///Default traits class of \ref GraphToEps.
11.11 ///
12.1 --- a/lemon/list_graph.h Wed Oct 08 17:05:01 2008 +0100
12.2 +++ b/lemon/list_graph.h Thu Oct 09 10:09:44 2008 +0200
12.3 @@ -413,7 +413,7 @@
12.4 /// Change the source of \c a to \c n
12.5 ///
12.6 ///\note The <tt>InArcIt</tt>s referencing the changed arc remain
12.7 - ///valid. However the <tt>ArcIt<tt>s and <tt>OutArcIt</tt>s are
12.8 + ///valid. However the <tt>ArcIt</tt>s and <tt>OutArcIt</tt>s are
12.9 ///invalidated.
12.10 ///
12.11 ///\warning This functionality cannot be used together with the Snapshot
13.1 --- a/lemon/maps.h Wed Oct 08 17:05:01 2008 +0100
13.2 +++ b/lemon/maps.h Thu Oct 09 10:09:44 2008 +0200
13.3 @@ -43,7 +43,7 @@
13.4 template<typename K, typename V>
13.5 class MapBase {
13.6 public:
13.7 - /// \biref The key type of the map.
13.8 + /// \brief The key type of the map.
13.9 typedef K Key;
13.10 /// \brief The value type of the map.
13.11 /// (The type of objects associated with the keys).
13.12 @@ -2266,7 +2266,7 @@
13.13 /// \brief Constructor
13.14 ///
13.15 /// Constructor
13.16 - /// \param _digraph The digraph that the map belongs to.
13.17 + /// \param digraph The digraph that the map belongs to.
13.18 explicit SourceMap(const Digraph& digraph) : _digraph(digraph) {}
13.19
13.20 /// \brief The subscript operator.
13.21 @@ -2305,7 +2305,7 @@
13.22 /// \brief Constructor
13.23 ///
13.24 /// Constructor
13.25 - /// \param _digraph The digraph that the map belongs to.
13.26 + /// \param digraph The digraph that the map belongs to.
13.27 explicit TargetMap(const Digraph& digraph) : _digraph(digraph) {}
13.28
13.29 /// \brief The subscript operator.
13.30 @@ -2344,7 +2344,7 @@
13.31 /// \brief Constructor
13.32 ///
13.33 /// Constructor
13.34 - /// \param _graph The graph that the map belongs to.
13.35 + /// \param graph The graph that the map belongs to.
13.36 explicit ForwardMap(const Graph& graph) : _graph(graph) {}
13.37
13.38 /// \brief The subscript operator.
13.39 @@ -2383,7 +2383,7 @@
13.40 /// \brief Constructor
13.41 ///
13.42 /// Constructor
13.43 - /// \param _graph The graph that the map belongs to.
13.44 + /// \param graph The graph that the map belongs to.
13.45 explicit BackwardMap(const Graph& graph) : _graph(graph) {}
13.46
13.47 /// \brief The subscript operator.
14.1 --- a/lemon/path.h Wed Oct 08 17:05:01 2008 +0100
14.2 +++ b/lemon/path.h Thu Oct 09 10:09:44 2008 +0200
14.3 @@ -849,7 +849,7 @@
14.4 /// \brief Return true when the path is empty.
14.5 int empty() const { return len == 0; }
14.6
14.7 - /// \break Erase all arcs in the digraph.
14.8 + /// \brief Erase all arcs in the digraph.
14.9 void clear() {
14.10 len = 0;
14.11 if (arcs) delete[] arcs;
15.1 --- a/lemon/smart_graph.h Wed Oct 08 17:05:01 2008 +0100
15.2 +++ b/lemon/smart_graph.h Thu Oct 09 10:09:44 2008 +0200
15.3 @@ -365,7 +365,7 @@
15.4 ///Constructor that immediately makes a snapshot
15.5
15.6 ///This constructor immediately makes a snapshot of the digraph.
15.7 - ///\param _g The digraph we make a snapshot of.
15.8 + ///\param graph The digraph we make a snapshot of.
15.9 Snapshot(SmartDigraph &graph) : _graph(&graph) {
15.10 node_num=_graph->nodes.size();
15.11 arc_num=_graph->arcs.size();
15.12 @@ -377,7 +377,7 @@
15.13 ///
15.14 ///This function can be called more than once. In case of a repeated
15.15 ///call, the previous snapshot gets lost.
15.16 - ///\param _g The digraph we make the snapshot of.
15.17 + ///\param graph The digraph we make the snapshot of.
15.18 void save(SmartDigraph &graph)
15.19 {
15.20 _graph=&graph;
15.21 @@ -775,7 +775,7 @@
15.22 ///Constructor that immediately makes a snapshot
15.23
15.24 ///This constructor immediately makes a snapshot of the digraph.
15.25 - ///\param g The digraph we make a snapshot of.
15.26 + ///\param graph The digraph we make a snapshot of.
15.27 Snapshot(SmartGraph &graph) {
15.28 graph.saveSnapshot(*this);
15.29 }
15.30 @@ -786,7 +786,7 @@
15.31 ///
15.32 ///This function can be called more than once. In case of a repeated
15.33 ///call, the previous snapshot gets lost.
15.34 - ///\param g The digraph we make the snapshot of.
15.35 + ///\param graph The digraph we make the snapshot of.
15.36 void save(SmartGraph &graph)
15.37 {
15.38 graph.saveSnapshot(*this);
16.1 --- a/lemon/time_measure.h Wed Oct 08 17:05:01 2008 +0100
16.2 +++ b/lemon/time_measure.h Thu Oct 09 10:09:44 2008 +0200
16.3 @@ -311,12 +311,11 @@
16.4 ///\name Control the state of the timer
16.5 ///Basically a Timer can be either running or stopped,
16.6 ///but it provides a bit finer control on the execution.
16.7 - ///The \ref Timer also counts the number of \ref start()
16.8 - ///executions, and is stops only after the same amount (or more)
16.9 - ///\ref stop() "stop()"s. This can be useful e.g. to compute
16.10 - ///the running time
16.11 + ///The \ref lemon::Timer "Timer" also counts the number of
16.12 + ///\ref lemon::Timer::start() "start()" executions, and it stops
16.13 + ///only after the same amount (or more) \ref lemon::Timer::stop()
16.14 + ///"stop()"s. This can be useful e.g. to compute the running time
16.15 ///of recursive functions.
16.16 - ///
16.17
16.18 ///@{
16.19
16.20 @@ -472,7 +471,7 @@
16.21 ///@}
16.22 };
16.23
16.24 - ///Same as \ref Timer but prints a report on destruction.
16.25 + ///Same as Timer but prints a report on destruction.
16.26
16.27 ///Same as \ref Timer but prints a report on destruction.
16.28 ///This example shows its usage.
16.29 @@ -491,22 +490,22 @@
16.30 std::string _title;
16.31 std::ostream &_os;
16.32 public:
16.33 - ///\e
16.34 + ///Constructor
16.35
16.36 + ///Constructor.
16.37 ///\param title This text will be printed before the ellapsed time.
16.38 ///\param os The stream to print the report to.
16.39 ///\param run Sets whether the timer should start immediately.
16.40 -
16.41 TimeReport(std::string title,std::ostream &os=std::cerr,bool run=true)
16.42 : Timer(run), _title(title), _os(os){}
16.43 - ///\e Prints the ellapsed time on destruction.
16.44 + ///Destructor that prints the ellapsed time
16.45 ~TimeReport()
16.46 {
16.47 _os << _title << *this << std::endl;
16.48 }
16.49 };
16.50
16.51 - ///'Do nothing' version of \ref TimeReport
16.52 + ///'Do nothing' version of TimeReport
16.53
16.54 ///\sa TimeReport
16.55 ///