Changeset 1250:97d978243703 in lemon

Timestamp:

08/05/13 14:03:29 (11 years ago)

Author:

Alpar Juttner <alpar@…>

Branch:

default

Phase:

public

Message:

Fix unresolved doc references (#459)

Files:

• doc/Doxyfile.in (modified) (1 diff)
• doc/lgf.dox (modified) (1 diff)
• lemon/bellman_ford.h (modified) (1 diff)
• lemon/bfs.h (modified) (1 diff)
• lemon/capacity_scaling.h (modified) (1 diff)
• lemon/christofides_tsp.h (modified) (1 diff)
• lemon/circulation.h (modified) (1 diff)
• lemon/cost_scaling.h (modified) (1 diff)
• lemon/cplex.h (modified) (1 diff)
• lemon/dfs.h (modified) (1 diff)
• lemon/dijkstra.h (modified) (1 diff)
• lemon/edmonds_karp.h (modified) (2 diffs)
• lemon/fractional_matching.h (modified) (1 diff)
• lemon/glpk.h (modified) (1 diff)
• lemon/greedy_tsp.h (modified) (1 diff)
• lemon/hartmann_orlin_mmc.h (modified) (1 diff)
• lemon/howard_mmc.h (modified) (1 diff)
• lemon/insertion_tsp.h (modified) (1 diff)
• lemon/karp_mmc.h (modified) (1 diff)
• lemon/lgf_reader.h (modified) (6 diffs)
• lemon/lgf_writer.h (modified) (6 diffs)
• lemon/lp_base.h (modified) (1 diff)
• lemon/min_cost_arborescence.h (modified) (1 diff)
• lemon/nearest_neighbor_tsp.h (modified) (1 diff)
• lemon/opt2_tsp.h (modified) (1 diff)
• lemon/preflow.h (modified) (1 diff)
• lemon/suurballe.h (modified) (1 diff)

doc/Doxyfile.in

@@ -100 +100 @@
                          "@abs_top_srcdir@/tools" \
                          "@abs_top_srcdir@/test/test_tools.h" \
-                         "@abs_top_builddir@/doc/mainpage.dox" \
-                         "@abs_top_builddir@/doc/references.dox"
+                         "@abs_top_builddir@/doc/mainpage.dox"
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.h \

doc/lgf.dox

@@ -65 +65 @@
 
 The \e LGF files can also contain bipartite graphs, in this case a
-\c @red_nodes and a \c @blue_nodes sections describe the node set of the
+\c \@red_nodes and a \c \@blue_nodes sections describe the node set of the
 graph. If a map is in both of these sections, then it can be used as a
 regular node map.

lemon/bellman_ford.h

@@ -201 +201 @@
     /// The type of the paths.
     typedef PredMapPath<Digraph, PredMap> Path;
-    ///\brief The \ref BellmanFordDefaultOperationTraits
+    ///\brief The \ref lemon::BellmanFordDefaultOperationTraits
     /// "operation traits class" of the algorithm.
     typedef typename TR::OperationTraits OperationTraits;
 
-    ///The \ref BellmanFordDefaultTraits "traits class" of the algorithm.
+    ///\brief The \ref lemon::BellmanFordDefaultTraits "traits class"
+    ///of the algorithm.
     typedef TR Traits;
 

lemon/bfs.h

@@ -153 +153 @@
     typedef PredMapPath<Digraph, PredMap> Path;
 
-    ///The \ref BfsDefaultTraits "traits class" of the algorithm.
+    ///The \ref lemon::BfsDefaultTraits "traits class" of the algorithm.
     typedef TR Traits;
 

lemon/capacity_scaling.h

@@ -119 +119 @@
     typedef typename TR::Heap Heap;
 
-    /// The \ref CapacityScalingDefaultTraits "traits class" of the algorithm
+    /// \brief The \ref lemon::CapacityScalingDefaultTraits "traits class"
+    /// of the algorithm
     typedef TR Traits;
 

lemon/christofides_tsp.h

@@ -232 +232 @@
       ///
       /// This function copies the found tour as a list of arcs/edges into
-      /// the given \ref concept::Path "path structure".
+      /// the given \ref lemon::concepts::Path "path structure".
       ///
       /// \pre run() must be called before using this function.

lemon/circulation.h

@@ -196 +196 @@
   public:
 
-    ///The \ref CirculationDefaultTraits "traits class" of the algorithm.
+    /// \brief The \ref lemon::CirculationDefaultTraits "traits class"
+    /// of the algorithm.
     typedef TR Traits;
     ///The type of the digraph the algorithm runs on.

lemon/cost_scaling.h

@@ -153 +153 @@
     typedef typename TR::LargeCost LargeCost;
 
-    /// The \ref CostScalingDefaultTraits "traits class" of the algorithm
+    /// \brief The \ref lemon::CostScalingDefaultTraits "traits class"
+    /// of the algorithm
     typedef TR Traits;
 

lemon/cplex.h

@@ -179 +179 @@
     /// to a file in the given format.
     /// Trying to write in an unsupported format will trigger
-    /// \ref UnsupportedFormatError.
+    /// \ref lemon::LpBase::UnsupportedFormatError "UnsupportedFormatError".
     /// \param file The file path
     /// \param format The output file format.

lemon/dfs.h

@@ -153 +153 @@
     typedef PredMapPath<Digraph, PredMap> Path;
 
-    ///The \ref DfsDefaultTraits "traits class" of the algorithm.
+    ///The \ref lemon::DfsDefaultTraits "traits class" of the algorithm.
     typedef TR Traits;
 

lemon/dijkstra.h

@@ -228 +228 @@
     ///The heap type used by the algorithm.
     typedef typename TR::Heap Heap;
-    ///\brief The \ref DijkstraDefaultOperationTraits "operation traits class"
-    ///of the algorithm.
+    /// \brief The \ref lemon::DijkstraDefaultOperationTraits
+    /// "operation traits class" of the algorithm.
     typedef typename TR::OperationTraits OperationTraits;
 
-    ///The \ref DijkstraDefaultTraits "traits class" of the algorithm.
+    ///The \ref lemon::DijkstraDefaultTraits "traits class" of the algorithm.
     typedef TR Traits;
 

lemon/edmonds_karp.h

@@ -81 +81 @@
   /// This class provides an implementation of the \e Edmonds-Karp \e
   /// algorithm producing a \ref max_flow "flow of maximum value" in a
-  /// digraph \ref clrs01algorithms, \ref amo93networkflows,
-  /// \ref edmondskarp72theoretical.
+  /// digraph \cite clrs01algorithms, \cite amo93networkflows,
+  /// \cite edmondskarp72theoretical.
   /// The Edmonds-Karp algorithm is slower than the Preflow
   /// algorithm, but it has an advantage of the step-by-step execution
@@ -113 +113 @@
   public:
 
-    /// The \ref EdmondsKarpDefaultTraits "traits class" of the algorithm.
+    /// \brief The \ref lemon::EdmondsKarpDefaultTraits "traits class"
+    /// of the algorithm.
     typedef TR Traits;
     /// The type of the digraph the algorithm runs on.

lemon/fractional_matching.h

@@ -124 +124 @@
   public:
 
-    /// \brief The \ref MaxFractionalMatchingDefaultTraits "traits
-    /// class" of the algorithm.
+    /// \brief The \ref lemon::MaxFractionalMatchingDefaultTraits
+    /// "traits class" of the algorithm.
     typedef TR Traits;
     /// The type of the graph the algorithm runs on.

lemon/glpk.h

@@ -153 +153 @@
     /// to a file in the given format.
     /// Trying to write in an unsupported format will trigger
-    /// \ref UnsupportedFormatError.
+    /// \ref LpBase::UnsupportedFormatError.
     /// \param file The file path
     /// \param format The output file format.

lemon/greedy_tsp.h

@@ -229 +229 @@
       ///
       /// This function copies the found tour as a list of arcs/edges into
-      /// the given \ref concept::Path "path structure".
+      /// the given \ref lemon::concepts::Path "path structure".
       ///
       /// \pre run() must be called before using this function.

lemon/hartmann_orlin_mmc.h

@@ -144 +144 @@
     ///
     /// The path type of the found cycles.
-    /// Using the \ref HartmannOrlinMmcDefaultTraits "default traits class",
+    /// Using the \ref lemon::HartmannOrlinMmcDefaultTraits
+    /// "default traits class",
     /// it is \ref lemon::Path "Path<Digraph>".
     typedef typename TR::Path Path;
 
-    /// The \ref HartmannOrlinMmcDefaultTraits "traits class" of the algorithm
+    /// \brief The
+    /// \ref lemon::HartmannOrlinMmcDefaultTraits "traits class"
+    /// of the algorithm
     typedef TR Traits;
 

lemon/howard_mmc.h

@@ -143 +143 @@
     ///
     /// The path type of the found cycles.
-    /// Using the \ref HowardMmcDefaultTraits "default traits class",
+    /// Using the \ref lemon::HowardMmcDefaultTraits "default traits class",
     /// it is \ref lemon::Path "Path<Digraph>".
     typedef typename TR::Path Path;
 
-    /// The \ref HowardMmcDefaultTraits "traits class" of the algorithm
+    /// The \ref lemon::HowardMmcDefaultTraits "traits class" of the algorithm
     typedef TR Traits;
 

lemon/insertion_tsp.h

@@ -226 +226 @@
       ///
       /// This function copies the found tour as a list of arcs/edges into
-      /// the given \ref concept::Path "path structure".
+      /// the given \ref lemon::concepts::Path "path structure".
       ///
       /// \pre run() must be called before using this function.

lemon/karp_mmc.h

@@ -141 +141 @@
     ///
     /// The path type of the found cycles.
-    /// Using the \ref KarpMmcDefaultTraits "default traits class",
+    /// Using the \ref lemon::KarpMmcDefaultTraits "default traits class",
     /// it is \ref lemon::Path "Path<Digraph>".
     typedef typename TR::Path Path;
 
-    /// The \ref KarpMmcDefaultTraits "traits class" of the algorithm
+    /// The \ref lemon::KarpMmcDefaultTraits "traits class" of the algorithm
     typedef TR Traits;
 

lemon/lgf_reader.h

@@ -1231 +1231 @@
   /// \ingroup lemon_io
   ///
-  /// \brief Return a \ref DigraphReader class
-  ///
-  /// This function just returns a \ref DigraphReader class.
+  /// \brief Return a \ref lemon::DigraphReader "DigraphReader" class
+  ///
+  /// This function just returns a \ref lemon::DigraphReader
+  /// "DigraphReader" class.
   ///
   /// With this function a digraph can be read from an
@@ -1253 +1254 @@
   ///\endcode
   ///
-  /// For a complete documentation, please see the \ref DigraphReader
+  /// For a complete documentation, please see the
+  /// \ref lemon::DigraphReader "DigraphReader"
   /// class documentation.
-  /// \warning Don't forget to put the \ref DigraphReader::run() "run()"
+  /// \warning Don't forget to put the \ref lemon::DigraphReader::run() "run()"
   /// to the end of the parameter list.
   /// \relates DigraphReader
@@ -2109 +2111 @@
   /// \ingroup lemon_io
   ///
-  /// \brief Return a \ref GraphReader class
-  ///
-  /// This function just returns a \ref GraphReader class.
+  /// \brief Return a \ref lemon::GraphReader "GraphReader" class
+  ///
+  /// This function just returns a \ref lemon::GraphReader "GraphReader" class.
   ///
   /// With this function a graph can be read from an
@@ -2127 +2129 @@
   ///\endcode
   ///
-  /// For a complete documentation, please see the \ref GraphReader
+  /// For a complete documentation, please see the
+  /// \ref lemon::GraphReader "GraphReader"
   /// class documentation.
-  /// \warning Don't forget to put the \ref GraphReader::run() "run()"
+  /// \warning Don't forget to put the \ref lemon::GraphReader::run() "run()"
   /// to the end of the parameter list.
   /// \relates GraphReader
@@ -3175 +3178 @@
   /// \ingroup lemon_io
   ///
-  /// \brief Return a \ref BpGraphReader class
-  ///
-  /// This function just returns a \ref BpGraphReader class.
+  /// \brief Return a \ref lemon::BpGraphReader "BpGraphReader" class
+  ///
+  /// This function just returns a \ref lemon::BpGraphReader
+  /// "BpGraphReader" class.
   ///
   /// With this function a graph can be read from an
@@ -3193 +3197 @@
   ///\endcode
   ///
-  /// For a complete documentation, please see the \ref BpGraphReader
+  /// For a complete documentation, please see the
+  /// \ref lemon::BpGraphReader "BpGraphReader"
   /// class documentation.
-  /// \warning Don't forget to put the \ref BpGraphReader::run() "run()"
+  /// \warning Don't forget to put the \ref lemon::BpGraphReader::run() "run()"
   /// to the end of the parameter list.
   /// \relates BpGraphReader

lemon/lgf_writer.h

@@ -945 +945 @@
   /// \ingroup lemon_io
   ///
-  /// \brief Return a \ref DigraphWriter class
-  ///
-  /// This function just returns a \ref DigraphWriter class.
+  /// \brief Return a \ref lemon::DigraphWriter "DigraphWriter" class
+  ///
+  /// This function just returns a \ref lemon::DigraphWriter
+  /// "DigraphWriter" class.
   ///
   /// With this function a digraph can be write to a file or output
@@ -968 +969 @@
   ///\endcode
   ///
-  /// For a complete documentation, please see the \ref DigraphWriter
+  /// For a complete documentation, please see the
+  /// \ref lemon::DigraphWriter "DigraphWriter"
   /// class documentation.
-  /// \warning Don't forget to put the \ref DigraphWriter::run() "run()"
+  /// \warning Don't forget to put the \ref lemon::DigraphWriter::run() "run()"
   /// to the end of the parameter list.
   /// \relates DigraphWriter
@@ -1584 +1586 @@
   /// \ingroup lemon_io
   ///
-  /// \brief Return a \ref GraphWriter class
-  ///
-  /// This function just returns a \ref GraphWriter class.
+  /// \brief Return a \ref lemon::GraphWriter "GraphWriter" class
+  ///
+  /// This function just returns a \ref lemon::GraphWriter "GraphWriter" class.
   ///
   /// With this function a graph can be write to a file or output
@@ -1603 +1605 @@
   ///\endcode
   ///
-  /// For a complete documentation, please see the \ref GraphWriter
+  /// For a complete documentation, please see the
+  /// \ref lemon::GraphWriter "GraphWriter"
   /// class documentation.
-  /// \warning Don't forget to put the \ref GraphWriter::run() "run()"
+  /// \warning Don't forget to put the \ref lemon::GraphWriter::run() "run()"
   /// to the end of the parameter list.
   /// \relates GraphWriter
@@ -2402 +2405 @@
   /// \ingroup lemon_io
   ///
-  /// \brief Return a \ref BpGraphWriter class
-  ///
-  /// This function just returns a \ref BpGraphWriter class.
+  /// \brief Return a \ref lemon::BpGraphWriter "BpGraphWriter" class
+  ///
+  /// This function just returns a \ref lemon::BpGraphWriter
+  /// "BpGraphWriter" class.
   ///
   /// With this function a bipartite graph can be write to a file or output
@@ -2421 +2425 @@
   ///\endcode
   ///
-  /// For a complete documentation, please see the \ref BpGraphWriter
+  /// For a complete documentation, please see the
+  /// \ref lemon::BpGraphWriter "BpGraphWriter"
   /// class documentation.
-  /// \warning Don't forget to put the \ref BpGraphWriter::run() "run()"
+  /// \warning Don't forget to put the \ref lemon::BpGraphWriter::run() "run()"
   /// to the end of the parameter list.
   /// \relates BpGraphWriter

lemon/lp_base.h

@@ -1008 +1008 @@
   public:
 
-    ///\e
+    ///\e \ 
     class UnsupportedFormatError : public Exception
     {

lemon/min_cost_arborescence.h

@@ -129 +129 @@
   public:
 
-    /// \brief The \ref MinCostArborescenceDefaultTraits "traits class"
+    /// \brief The \ref lemon::MinCostArborescenceDefaultTraits "traits class"
     /// of the algorithm.
     typedef TR Traits;

lemon/nearest_neighbor_tsp.h

@@ -216 +216 @@
       ///
       /// This function copies the found tour as a list of arcs/edges into
-      /// the given \ref concept::Path "path structure".
+      /// the given \ref lemon::concepts::Path "path structure".
       ///
       /// \pre run() must be called before using this function.

lemon/opt2_tsp.h

@@ -253 +253 @@
       ///
       /// This function copies the found tour as a list of arcs/edges into
-      /// the given \ref concept::Path "path structure".
+      /// the given \ref lemon::concepts::Path "path structure".
       ///
       /// \pre run() must be called before using this function.

lemon/preflow.h

@@ -135 +135 @@
   public:
 
-    ///The \ref PreflowDefaultTraits "traits class" of the algorithm.
+    ///The \ref lemon::PreflowDefaultTraits "traits class" of the algorithm.
     typedef TR Traits;
     ///The type of the digraph the algorithm runs on.

lemon/suurballe.h

@@ -138 +138 @@
     typedef typename TR::Heap Heap;
 
-    /// The \ref SuurballeDefaultTraits "traits class" of the algorithm.
+    /// The \ref lemon::SuurballeDefaultTraits "traits class" of the algorithm.
     typedef TR Traits;