Changeset 313:64f8f7cc6168 in lemon-main

Timestamp:

10/09/08 10:09:44 (16 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Fix several doxygen warnings

Files:

• demo/graph_to_eps_demo.cc (modified) (1 diff)
• doc/lgf.dox (modified) (1 diff)
• lemon/bits/alteration_notifier.h (modified) (1 diff)
• lemon/bits/default_map.h (modified) (1 diff)
• lemon/color.h (modified) (1 diff)
• lemon/concepts/graph_components.h (modified) (1 diff)
• lemon/core.h (modified) (3 diffs)
• lemon/dfs.h (modified) (1 diff)
• lemon/dijkstra.h (modified) (2 diffs)
• lemon/dim2.h (modified) (11 diffs)
• lemon/graph_to_eps.h (modified) (1 diff)
• lemon/list_graph.h (modified) (1 diff)
• lemon/maps.h (modified) (5 diffs)
• lemon/path.h (modified) (1 diff)
• lemon/smart_graph.h (modified) (4 diffs)
• lemon/time_measure.h (modified) (4 diffs)

demo/graph_to_eps_demo.cc

@@ -27 +27 @@
 /// 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

doc/lgf.dox

@@ -79 +79 @@
 \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

lemon/bits/alteration_notifier.h

@@ -80 +80 @@
   /// 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.
   ///

lemon/bits/default_map.h

@@ -150 +150 @@
 // #endif
 
-  /// \e
+  /// DefaultMap class
   template <typename _Graph, typename _Item, typename _Value>
   class DefaultMap

lemon/color.h

@@ -93 +93 @@
   extern const Color DARK_CYAN;
 
-  ///Map <tt>int</tt>s to different \ref Color "Color"s
+  ///Map <tt>int</tt>s to different <tt>Color</tt>s
 
   ///This map assigns one of the predefined \ref Color "Color"s to

lemon/concepts/graph_components.h

@@ -983 +983 @@
     ///
     /// 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 <typename _Graph, typename _Item, typename _Value>

lemon/core.h

@@ -1555 +1555 @@
     ///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  {
@@ -1700 +1700 @@
     ///Find an arc between two nodes.
 
-    ///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.
     ///\param t The target node.
@@ -1818 +1818 @@
     ///\endcode
     ///
-    ///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.
     ///

lemon/dfs.h

@@ -836 +836 @@
   };
 
-  /// Default traits class used by \ref DfsWizard
+  /// Default traits class used by DfsWizard
 
   /// To make it easier to use Dfs algorithm

lemon/dijkstra.h

@@ -454 +454 @@
 
     /// \brief \ref named-templ-param "Named parameter" for setting
-    ///\ref OperationTraits type
+    ///\c OperationTraits type
     ///
     ///\ref named-templ-param "Named parameter" for setting
@@ -1039 +1039 @@
   };
 
-  /// Default traits class used by \ref DijkstraWizard
+  /// Default traits class used by DijkstraWizard
 
   /// To make it easier to use Dijkstra algorithm

lemon/dim2.h

@@ -260 +260 @@
 
 
-  /// 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>
   class Box {
@@ -574 +574 @@
   }
 
-  ///Map of x-coordinates of a \ref Point "Point"-map
-
-  ///\ingroup maps
+  ///Map of x-coordinates of a <tt>Point</tt>-map
+
   ///Map of x-coordinates of a \ref Point "Point"-map.
-  ///
+  ///\ingroup maps
   template<class M>
   class XMap
@@ -593 +592 @@
   };
 
-  ///Returns an \ref XMap class
-
-  ///This function just returns an \ref XMap class.
+  ///Returns an XMap class
+
+  ///This function just returns an XMap class.
   ///
   ///\ingroup maps
@@ -611 +610 @@
   }
 
-  ///Constant (read only) version of \ref XMap
-
-  ///\ingroup maps
-  ///Constant (read only) version of \ref XMap
-  ///
+  ///Constant (read only) version of XMap
+
+  ///Constant (read only) version of XMap.
+  ///\ingroup maps
   template<class M>
   class ConstXMap
@@ -629 +627 @@
   };
 
-  ///Returns a \ref ConstXMap class
-
-  ///This function just returns a \ref ConstXMap class.
+  ///Returns a ConstXMap class
+
+  ///This function just returns a ConstXMap class.
   ///
   ///\ingroup maps
@@ -641 +639 @@
   }
 
-  ///Map of y-coordinates of a \ref Point "Point"-map
-
-  ///\ingroup maps
+  ///Map of y-coordinates of a <tt>Point</tt>-map
+
   ///Map of y-coordinates of a \ref Point "Point"-map.
-  ///
+  ///\ingroup maps
   template<class M>
   class YMap
@@ -660 +657 @@
   };
 
-  ///Returns a \ref YMap class
-
-  ///This function just returns a \ref YMap class.
+  ///Returns a YMap class
+
+  ///This function just returns a YMap class.
   ///
   ///\ingroup maps
@@ -678 +675 @@
   }
 
-  ///Constant (read only) version of \ref YMap
-
-  ///\ingroup maps
-  ///Constant (read only) version of \ref YMap
-  ///
+  ///Constant (read only) version of YMap
+
+  ///Constant (read only) version of YMap.
+  ///\ingroup maps
   template<class M>
   class ConstYMap
@@ -696 +692 @@
   };
 
-  ///Returns a \ref ConstYMap class
-
-  ///This function just returns a \ref ConstYMap class.
+  ///Returns a ConstYMap class
+
+  ///This function just returns a ConstYMap class.
   ///
   ///\ingroup maps
@@ -709 +705 @@
 
 
-  ///\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
   ///
   ///Map of the \ref Point::normSquare() "normSquare()"
@@ -728 +723 @@
   };
 
-  ///Returns a \ref NormSquareMap class
-
-  ///This function just returns a \ref NormSquareMap class.
+  ///Returns a NormSquareMap class
+
+  ///This function just returns a NormSquareMap class.
   ///
   ///\ingroup maps

lemon/graph_to_eps.h

@@ -63 +63 @@
   }
 
-///Default traits class of \ref GraphToEps
+///Default traits class of GraphToEps
 
 ///Default traits class of \ref GraphToEps.

lemon/list_graph.h

@@ -414 +414 @@
     ///
     ///\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.
     ///

lemon/maps.h

@@ -44 +44 @@
   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.
@@ -2267 +2267 @@
     ///
     /// 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) {}
 
@@ -2306 +2306 @@
     ///
     /// 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) {}
 
@@ -2345 +2345 @@
     ///
     /// 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) {}
 
@@ -2384 +2384 @@
     ///
     /// 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) {}
 

lemon/path.h

@@ -850 +850 @@
     int empty() const { return len == 0; }
 
-    /// \break Erase all arcs in the digraph.
+    /// \brief Erase all arcs in the digraph.
     void clear() {
       len = 0;

lemon/smart_graph.h

@@ -366 +366 @@
 
       ///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();
@@ -378 +378 @@
       ///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)
       {
@@ -776 +776 @@
 
       ///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);
@@ -787 +787 @@
       ///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)
       {

lemon/time_measure.h

@@ -312 +312 @@
     ///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.
-    ///
 
     ///@{
@@ -473 +472 @@
   };
 
-  ///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.
@@ -492 +491 @@
     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()
     {
@@ -507 +506 @@
   };
 
-  ///'Do nothing' version of \ref TimeReport
+  ///'Do nothing' version of TimeReport
 
   ///\sa TimeReport