# HG changeset patch # User Peter Kovacs # Date 1223539784 -7200 # Node ID 64f8f7cc6168b86c88ad05e447aecb9b1428c61e # Parent e57e10a8ea1b3b89a3350af00e85ca51d7ad1dfc Fix several doxygen warnings diff -r e57e10a8ea1b -r 64f8f7cc6168 demo/graph_to_eps_demo.cc --- a/demo/graph_to_eps_demo.cc Wed Oct 08 17:05:01 2008 +0100 +++ b/demo/graph_to_eps_demo.cc Thu Oct 09 10:09:44 2008 +0200 @@ -26,7 +26,7 @@ /// graphToEps(), and showing how to draw directed graphs, /// how to handle parallel egdes, how to change the properties (like /// color, shape, size, title etc.) of nodes and arcs individually -/// using appropriate \ref maps-page "graph maps". +/// using appropriate graph maps. /// /// \include graph_to_eps_demo.cc diff -r e57e10a8ea1b -r 64f8f7cc6168 doc/lgf.dox --- a/doc/lgf.dox Wed Oct 08 17:05:01 2008 +0100 +++ b/doc/lgf.dox Thu Oct 09 10:09:44 2008 +0200 @@ -78,7 +78,7 @@ 2 3 18 \endcode -The \c \@edges is just a synonym of \c \@arcs. The @arcs section can +The \c \@edges is just a synonym of \c \@arcs. The \@arcs section can also store the edge set of an undirected graph. In such case there is a conventional method for store arc maps in the file, if two columns has the same caption with \c '+' and \c '-' prefix, then these columns diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/bits/alteration_notifier.h --- a/lemon/bits/alteration_notifier.h Wed Oct 08 17:05:01 2008 +0100 +++ b/lemon/bits/alteration_notifier.h Thu Oct 09 10:09:44 2008 +0200 @@ -79,8 +79,7 @@ /// observeres will not be notified and the fulfilled additions will /// be rolled back by calling the \e erase() or \e clear() /// functions. Thence the \e erase() and \e clear() should not throw - /// exception. Actullay, it can be throw only - /// \ref AlterationObserver::ImmediateDetach ImmediateDetach + /// exception. Actullay, it can be throw only \ref ImmediateDetach /// exception which detach the observer from the notifier. /// /// There are some place when the alteration observing is not completly diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/bits/default_map.h --- a/lemon/bits/default_map.h Wed Oct 08 17:05:01 2008 +0100 +++ b/lemon/bits/default_map.h Thu Oct 09 10:09:44 2008 +0200 @@ -149,7 +149,7 @@ // #endif - /// \e + /// DefaultMap class template class DefaultMap : public DefaultMapSelector<_Graph, _Item, _Value>::Map { diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/color.h --- a/lemon/color.h Wed Oct 08 17:05:01 2008 +0100 +++ b/lemon/color.h Thu Oct 09 10:09:44 2008 +0200 @@ -92,7 +92,7 @@ /// Dark cyan color constant extern const Color DARK_CYAN; - ///Map ints to different \ref Color "Color"s + ///Map ints to different Colors ///This map assigns one of the predefined \ref Color "Color"s to ///each int. It is possible to change the colors as well as diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/concepts/graph_components.h --- a/lemon/concepts/graph_components.h Wed Oct 08 17:05:01 2008 +0100 +++ b/lemon/concepts/graph_components.h Thu Oct 09 10:09:44 2008 +0200 @@ -982,7 +982,7 @@ /// \brief Class describing the concept of graph maps /// /// This class describes the common interface of the graph maps - /// (NodeMap, ArcMap), that is \ref maps-page "maps" which can be used to + /// (NodeMap, ArcMap), that is maps that can be used to /// associate data to graph descriptors (nodes or arcs). template class GraphMap : public ReadWriteMap<_Item, _Value> { diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/core.h --- a/lemon/core.h Wed Oct 08 17:05:01 2008 +0100 +++ b/lemon/core.h Thu Oct 09 10:09:44 2008 +0200 @@ -1554,7 +1554,7 @@ ///\note This is a dynamic data structure, therefore the data ///structure is updated after each graph alteration. Thus although ///this data structure is theoretically faster than \ref ArcLookUp - ///and \ref AllArcLookup, it often provides worse performance than + ///and \ref AllArcLookUp, it often provides worse performance than ///them. Arc operator()(Node s, Node t, Arc p = INVALID) const { if (p == INVALID) { @@ -1699,8 +1699,8 @@ ///Find an arc between two nodes. - ///Find an arc between two nodes in time O(logd), where - ///d is the number of outgoing arcs of \c s. + ///Find an arc between two nodes in time O(logd), + ///where d is the number of outgoing arcs of \c s. ///\param s The source node. ///\param t The target node. ///\return An arc from \c s to \c t if there exists, @@ -1817,8 +1817,8 @@ ///for(Arc a = ae(u,v); a != INVALID; a=ae(u,v,a)) n++; ///\endcode /// - ///Finding the first arc take O(logd) time, where - ///d is the number of outgoing arcs of \c s. Then, the + ///Finding the first arc take O(logd) time, + ///where d is the number of outgoing arcs of \c s. Then the ///consecutive arcs are found in constant time. /// ///\warning If you change the digraph, refresh() must be called before using diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/dfs.h --- a/lemon/dfs.h Wed Oct 08 17:05:01 2008 +0100 +++ b/lemon/dfs.h Thu Oct 09 10:09:44 2008 +0200 @@ -835,7 +835,7 @@ typedef lemon::Path Path; }; - /// Default traits class used by \ref DfsWizard + /// Default traits class used by DfsWizard /// To make it easier to use Dfs algorithm /// we have created a wizard class. diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/dijkstra.h --- a/lemon/dijkstra.h Wed Oct 08 17:05:01 2008 +0100 +++ b/lemon/dijkstra.h Thu Oct 09 10:09:44 2008 +0200 @@ -453,7 +453,7 @@ }; /// \brief \ref named-templ-param "Named parameter" for setting - ///\ref OperationTraits type + ///\c OperationTraits type /// ///\ref named-templ-param "Named parameter" for setting ///\ref OperationTraits type. @@ -1038,7 +1038,7 @@ typedef lemon::Path Path; }; - /// Default traits class used by \ref DijkstraWizard + /// Default traits class used by DijkstraWizard /// To make it easier to use Dijkstra algorithm /// we have created a wizard class. diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/dim2.h --- a/lemon/dim2.h Wed Oct 08 17:05:01 2008 +0100 +++ b/lemon/dim2.h Thu Oct 09 10:09:44 2008 +0200 @@ -259,10 +259,10 @@ - /// Bounding box of plain vectors (\ref Point points). + /// Bounding box of plain vectors (points). /// A class to calculate or store the bounding box of plain vectors - /// (\ref Point points). + /// (\ref Point "points"). template class Box { Point _bottom_left, _top_right; @@ -573,11 +573,10 @@ return os; } - ///Map of x-coordinates of a \ref Point "Point"-map + ///Map of x-coordinates of a Point-map + ///Map of x-coordinates of a \ref Point "Point"-map. ///\ingroup maps - ///Map of x-coordinates of a \ref Point "Point"-map. - /// template class XMap { @@ -592,9 +591,9 @@ void set(Key k,Value v) {_map.set(k,typename M::Value(v,_map[k].y));} }; - ///Returns an \ref XMap class + ///Returns an XMap class - ///This function just returns an \ref XMap class. + ///This function just returns an XMap class. /// ///\ingroup maps ///\relates XMap @@ -610,11 +609,10 @@ return XMap(m); } - ///Constant (read only) version of \ref XMap + ///Constant (read only) version of XMap + ///Constant (read only) version of XMap. ///\ingroup maps - ///Constant (read only) version of \ref XMap - /// template class ConstXMap { @@ -628,9 +626,9 @@ Value operator[](Key k) const {return _map[k].x;} }; - ///Returns a \ref ConstXMap class + ///Returns a ConstXMap class - ///This function just returns a \ref ConstXMap class. + ///This function just returns a ConstXMap class. /// ///\ingroup maps ///\relates ConstXMap @@ -640,11 +638,10 @@ return ConstXMap(m); } - ///Map of y-coordinates of a \ref Point "Point"-map + ///Map of y-coordinates of a Point-map + ///Map of y-coordinates of a \ref Point "Point"-map. ///\ingroup maps - ///Map of y-coordinates of a \ref Point "Point"-map. - /// template class YMap { @@ -659,9 +656,9 @@ void set(Key k,Value v) {_map.set(k,typename M::Value(_map[k].x,v));} }; - ///Returns a \ref YMap class + ///Returns a YMap class - ///This function just returns a \ref YMap class. + ///This function just returns a YMap class. /// ///\ingroup maps ///\relates YMap @@ -677,11 +674,10 @@ return YMap(m); } - ///Constant (read only) version of \ref YMap + ///Constant (read only) version of YMap + ///Constant (read only) version of YMap. ///\ingroup maps - ///Constant (read only) version of \ref YMap - /// template class ConstYMap { @@ -695,9 +691,9 @@ Value operator[](Key k) const {return _map[k].y;} }; - ///Returns a \ref ConstYMap class + ///Returns a ConstYMap class - ///This function just returns a \ref ConstYMap class. + ///This function just returns a ConstYMap class. /// ///\ingroup maps ///\relates ConstYMap @@ -708,8 +704,7 @@ } - ///\brief Map of the \ref Point::normSquare() "normSquare()" - ///of a \ref Point "Point"-map + ///\brief Map of the normSquare() of a Point-map /// ///Map of the \ref Point::normSquare() "normSquare()" ///of a \ref Point "Point"-map. @@ -727,9 +722,9 @@ Value operator[](Key k) const {return _map[k].normSquare();} }; - ///Returns a \ref NormSquareMap class + ///Returns a NormSquareMap class - ///This function just returns a \ref NormSquareMap class. + ///This function just returns a NormSquareMap class. /// ///\ingroup maps ///\relates NormSquareMap diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/graph_to_eps.h --- a/lemon/graph_to_eps.h Wed Oct 08 17:05:01 2008 +0100 +++ b/lemon/graph_to_eps.h Thu Oct 09 10:09:44 2008 +0200 @@ -62,7 +62,7 @@ }; } -///Default traits class of \ref GraphToEps +///Default traits class of GraphToEps ///Default traits class of \ref GraphToEps. /// diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/list_graph.h --- a/lemon/list_graph.h Wed Oct 08 17:05:01 2008 +0100 +++ b/lemon/list_graph.h Thu Oct 09 10:09:44 2008 +0200 @@ -413,7 +413,7 @@ /// Change the source of \c a to \c n /// ///\note The InArcIts referencing the changed arc remain - ///valid. However the ArcIts and OutArcIts are + ///valid. However the ArcIts and OutArcIts are ///invalidated. /// ///\warning This functionality cannot be used together with the Snapshot diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/maps.h --- a/lemon/maps.h Wed Oct 08 17:05:01 2008 +0100 +++ b/lemon/maps.h Thu Oct 09 10:09:44 2008 +0200 @@ -43,7 +43,7 @@ template class MapBase { public: - /// \biref The key type of the map. + /// \brief The key type of the map. typedef K Key; /// \brief The value type of the map. /// (The type of objects associated with the keys). @@ -2266,7 +2266,7 @@ /// \brief Constructor /// /// Constructor - /// \param _digraph The digraph that the map belongs to. + /// \param digraph The digraph that the map belongs to. explicit SourceMap(const Digraph& digraph) : _digraph(digraph) {} /// \brief The subscript operator. @@ -2305,7 +2305,7 @@ /// \brief Constructor /// /// Constructor - /// \param _digraph The digraph that the map belongs to. + /// \param digraph The digraph that the map belongs to. explicit TargetMap(const Digraph& digraph) : _digraph(digraph) {} /// \brief The subscript operator. @@ -2344,7 +2344,7 @@ /// \brief Constructor /// /// Constructor - /// \param _graph The graph that the map belongs to. + /// \param graph The graph that the map belongs to. explicit ForwardMap(const Graph& graph) : _graph(graph) {} /// \brief The subscript operator. @@ -2383,7 +2383,7 @@ /// \brief Constructor /// /// Constructor - /// \param _graph The graph that the map belongs to. + /// \param graph The graph that the map belongs to. explicit BackwardMap(const Graph& graph) : _graph(graph) {} /// \brief The subscript operator. diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/path.h --- a/lemon/path.h Wed Oct 08 17:05:01 2008 +0100 +++ b/lemon/path.h Thu Oct 09 10:09:44 2008 +0200 @@ -849,7 +849,7 @@ /// \brief Return true when the path is empty. int empty() const { return len == 0; } - /// \break Erase all arcs in the digraph. + /// \brief Erase all arcs in the digraph. void clear() { len = 0; if (arcs) delete[] arcs; diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/smart_graph.h --- a/lemon/smart_graph.h Wed Oct 08 17:05:01 2008 +0100 +++ b/lemon/smart_graph.h Thu Oct 09 10:09:44 2008 +0200 @@ -365,7 +365,7 @@ ///Constructor that immediately makes a snapshot ///This constructor immediately makes a snapshot of the digraph. - ///\param _g The digraph we make a snapshot of. + ///\param graph The digraph we make a snapshot of. Snapshot(SmartDigraph &graph) : _graph(&graph) { node_num=_graph->nodes.size(); arc_num=_graph->arcs.size(); @@ -377,7 +377,7 @@ /// ///This function can be called more than once. In case of a repeated ///call, the previous snapshot gets lost. - ///\param _g The digraph we make the snapshot of. + ///\param graph The digraph we make the snapshot of. void save(SmartDigraph &graph) { _graph=&graph; @@ -775,7 +775,7 @@ ///Constructor that immediately makes a snapshot ///This constructor immediately makes a snapshot of the digraph. - ///\param g The digraph we make a snapshot of. + ///\param graph The digraph we make a snapshot of. Snapshot(SmartGraph &graph) { graph.saveSnapshot(*this); } @@ -786,7 +786,7 @@ /// ///This function can be called more than once. In case of a repeated ///call, the previous snapshot gets lost. - ///\param g The digraph we make the snapshot of. + ///\param graph The digraph we make the snapshot of. void save(SmartGraph &graph) { graph.saveSnapshot(*this); diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/time_measure.h --- a/lemon/time_measure.h Wed Oct 08 17:05:01 2008 +0100 +++ b/lemon/time_measure.h Thu Oct 09 10:09:44 2008 +0200 @@ -311,12 +311,11 @@ ///\name Control the state of the timer ///Basically a Timer can be either running or stopped, ///but it provides a bit finer control on the execution. - ///The \ref Timer also counts the number of \ref start() - ///executions, and is stops only after the same amount (or more) - ///\ref stop() "stop()"s. This can be useful e.g. to compute - ///the running time + ///The \ref lemon::Timer "Timer" also counts the number of + ///\ref lemon::Timer::start() "start()" executions, and it stops + ///only after the same amount (or more) \ref lemon::Timer::stop() + ///"stop()"s. This can be useful e.g. to compute the running time ///of recursive functions. - /// ///@{ @@ -472,7 +471,7 @@ ///@} }; - ///Same as \ref Timer but prints a report on destruction. + ///Same as Timer but prints a report on destruction. ///Same as \ref Timer but prints a report on destruction. ///This example shows its usage. @@ -491,22 +490,22 @@ std::string _title; std::ostream &_os; public: - ///\e + ///Constructor + ///Constructor. ///\param title This text will be printed before the ellapsed time. ///\param os The stream to print the report to. ///\param run Sets whether the timer should start immediately. - TimeReport(std::string title,std::ostream &os=std::cerr,bool run=true) : Timer(run), _title(title), _os(os){} - ///\e Prints the ellapsed time on destruction. + ///Destructor that prints the ellapsed time ~TimeReport() { _os << _title << *this << std::endl; } }; - ///'Do nothing' version of \ref TimeReport + ///'Do nothing' version of TimeReport ///\sa TimeReport ///