LEMON/LEMON-official Changeset - r313:64f8f7cc6168

Repositories » LEMON » LEMON-official

Summary
Changelog
Files
Switch To
- loading...
Options
- Lightweight changelog
- Search
Pull Requests

Changeset - r313:64f8f7cc6168

« 309:e57e10

314:2cc608 »

r313:64f8f7cc6168

Thu, 09 Oct 2008 10:09:44

[Not Reviewed]

0 comments (0 inline)

kpeter (Peter Kovacs)
kpeter@inf.elte.hu

Fix several doxygen warnings

0 16 0

default

16 files changed with 56 insertions and 63 deletions:

demo/graph_to_eps_demo.cc

doc/lgf.dox

lemon/bits/alteration_notifier.h

lemon/bits/default_map.h

lemon/color.h

lemon/concepts/graph_components.h

lemon/core.h

lemon/dfs.h

lemon/dijkstra.h

lemon/dim2.h

lemon/graph_to_eps.h

lemon/list_graph.h

lemon/maps.h

lemon/path.h

lemon/smart_graph.h

lemon/time_measure.h

↑ Collapse diff ↑

0 comments (0 inline)

@@ -28,3 +28,3 @@
 		/// color, shape, size, title etc.) of nodes and arcs individually
-		/// using appropriate \ref maps-page "graph maps".
 		/// using appropriate graph maps.
 		///

@@ -80,3 +80,3 @@
 		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

@@ -81,4 +81,3 @@
 		  /// 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.

@@ -151,3 +151,3 @@
-		  /// \e
+		  /// DefaultMap class
 		  template <typename _Graph, typename _Item, typename _Value>

@@ -94,3 +94,3 @@
-		  ///Map <tt>int</tt>s to different \ref Color "Color"s
+		  ///Map <tt>int</tt>s to different <tt>Color</tt>s

RhodeCode

Login to your account

@@ -984,3 +984,3 @@
 		    /// 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).

@@ -1556,3 +1556,3 @@
 		    ///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.
@@ -1701,4 +1701,4 @@
 		    ///Find an arc between two nodes in time <em>O</em>(log<em>d</em>), where
 		    ///<em>d</em> is the number of outgoing arcs of \c s.
 		    ///Find an arc between two nodes in time <em>O</em>(log<em>d</em>),
 		    ///where <em>d</em> is the number of outgoing arcs of \c s.
 		    ///\param s The source node.
@@ -1819,4 +1819,4 @@
 		    ///
 		    ///Finding the first arc take <em>O</em>(log<em>d</em>) time, where
 		    ///<em>d</em> is the number of outgoing arcs of \c s. Then, the
 		    ///Finding the first arc take <em>O</em>(log<em>d</em>) time,
 		    ///where <em>d</em> is the number of outgoing arcs of \c s. Then the
 		    ///consecutive arcs are found in constant time.

@@ -837,3 +837,3 @@
-		  /// Default traits class used by \ref DfsWizard
 		  /// Default traits class used by DfsWizard

@@ -455,3 +455,3 @@
 		    /// \brief \ref named-templ-param "Named parameter" for setting
-		    ///\ref OperationTraits type
+		    ///\c OperationTraits type
 		    ///
@@ -1040,3 +1040,3 @@
-		  /// Default traits class used by \ref DijkstraWizard
 		  /// Default traits class used by DijkstraWizard

@@ -261,6 +261,6 @@
-		  /// 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<typename T>
@@ -575,7 +575,6 @@
-		  ///Map of x-coordinates of a \ref Point "Point"-map
+		  ///Map of x-coordinates of a <tt>Point</tt>-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 M>
@@ -594,5 +593,5 @@
-		  ///Returns an \ref XMap class
 		  ///Returns an XMap class
-		  ///This function just returns an \ref XMap class.
 		  ///This function just returns an XMap class.
 		  ///
@@ -612,7 +611,6 @@
-		  ///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 M>
@@ -630,5 +628,5 @@
-		  ///Returns a \ref ConstXMap class
 		  ///Returns a ConstXMap class
-		  ///This function just returns a \ref ConstXMap class.
 		  ///This function just returns a ConstXMap class.
 		  ///
@@ -642,7 +640,6 @@
-		  ///Map of y-coordinates of a \ref Point "Point"-map
+		  ///Map of y-coordinates of a <tt>Point</tt>-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 M>
@@ -661,5 +658,5 @@
-		  ///Returns a \ref YMap class
 		  ///Returns a YMap class
-		  ///This function just returns a \ref YMap class.
 		  ///This function just returns a YMap class.
 		  ///
@@ -679,7 +676,6 @@
-		  ///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 M>
@@ -697,5 +693,5 @@
-		  ///Returns a \ref ConstYMap class
 		  ///Returns a ConstYMap class
-		  ///This function just returns a \ref ConstYMap class.
 		  ///This function just returns a ConstYMap class.
 		  ///
@@ -710,4 +706,3 @@
 		  ///\brief Map of the \ref Point::normSquare() "normSquare()"
 		  ///of a \ref Point "Point"-map
 		  ///\brief Map of the normSquare() of a <tt>Point</tt>-map
 		  ///
@@ -729,5 +724,5 @@
-		  ///Returns a \ref NormSquareMap class
 		  ///Returns a NormSquareMap class
-		  ///This function just returns a \ref NormSquareMap class.
 		  ///This function just returns a NormSquareMap class.
 		  ///

@@ -64,3 +64,3 @@
-		///Default traits class of \ref GraphToEps
 		///Default traits class of GraphToEps

@@ -415,3 +415,3 @@
 		    ///\note The <tt>InArcIt</tt>s referencing the changed arc remain
 		    ///valid. However the <tt>ArcIt<tt>s and <tt>OutArcIt</tt>s are
+		    ///valid. However the <tt>ArcIt</tt>s and <tt>OutArcIt</tt>s are
 		    ///invalidated.

@@ -45,3 +45,3 @@
 		  public:
-		    /// \biref The key type of the map.
+		    /// \brief The key type of the map.
 		    typedef K Key;
@@ -2268,3 +2268,3 @@
 		    /// 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) {}
@@ -2307,3 +2307,3 @@
 		    /// 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) {}
@@ -2346,3 +2346,3 @@
 		    /// 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) {}
@@ -2385,3 +2385,3 @@
 		    /// 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) {}

@@ -851,3 +851,3 @@
-		    /// \break Erase all arcs in the digraph.
+		    /// \brief Erase all arcs in the digraph.
 		    void clear() {

@@ -367,3 +367,3 @@
 		      ///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) {
@@ -379,3 +379,3 @@
 		      ///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)
@@ -777,3 +777,3 @@
 		      ///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) {
@@ -788,3 +788,3 @@
 		      ///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)

@@ -313,8 +313,7 @@
 		    ///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.
 		    ///
@@ -474,3 +473,3 @@
-		  ///Same as \ref Timer but prints a report on destruction.
 		  ///Same as Timer but prints a report on destruction.
@@ -493,4 +492,5 @@
 		  public:
-		    ///\e
+		    ///Constructor
 		    ///Constructor.
 		    ///\param title This text will be printed before the ellapsed time.
@@ -498,6 +498,5 @@
 		    ///\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()
@@ -508,3 +507,3 @@
-		  ///'Do nothing' version of \ref TimeReport
 		  ///'Do nothing' version of TimeReport