# HG changeset patch
# User Alpar Juttner <alpar@cs.elte.hu>
# Date 1375704209 -7200
# Node ID 97d97824370316f3524235c8c4d5eeb72ece87f7
# Parent 73c892335e748075d51db6f31641dfed996188cd
Fix unresolved doc references (#459)
diff -r 73c892335e74 -r 97d978243703 doc/Doxyfile.in
--- a/doc/Doxyfile.in Tue Jul 30 15:54:46 2013 +0200
+++ b/doc/Doxyfile.in Mon Aug 05 14:03:29 2013 +0200
@@ -99,8 +99,7 @@
"@abs_top_srcdir@/contrib" \
"@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 \
*.cc \
diff -r 73c892335e74 -r 97d978243703 doc/lgf.dox
--- a/doc/lgf.dox Tue Jul 30 15:54:46 2013 +0200
+++ b/doc/lgf.dox Mon Aug 05 14:03:29 2013 +0200
@@ -64,7 +64,7 @@
\endcode
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.
diff -r 73c892335e74 -r 97d978243703 lemon/bellman_ford.h
--- a/lemon/bellman_ford.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/bellman_ford.h Mon Aug 05 14:03:29 2013 +0200
@@ -200,11 +200,12 @@
typedef typename TR::DistMap DistMap;
/// 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;
private:
diff -r 73c892335e74 -r 97d978243703 lemon/bfs.h
--- a/lemon/bfs.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/bfs.h Mon Aug 05 14:03:29 2013 +0200
@@ -152,7 +152,7 @@
///The type of the paths.
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;
private:
diff -r 73c892335e74 -r 97d978243703 lemon/capacity_scaling.h
--- a/lemon/capacity_scaling.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/capacity_scaling.h Mon Aug 05 14:03:29 2013 +0200
@@ -118,7 +118,8 @@
/// The type of the heap used for internal Dijkstra computations
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;
public:
diff -r 73c892335e74 -r 97d978243703 lemon/christofides_tsp.h
--- a/lemon/christofides_tsp.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/christofides_tsp.h Mon Aug 05 14:03:29 2013 +0200
@@ -231,7 +231,7 @@
/// \brief Gives back the found tour as a path.
///
/// 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.
template <typename Path>
diff -r 73c892335e74 -r 97d978243703 lemon/circulation.h
--- a/lemon/circulation.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/circulation.h Mon Aug 05 14:03:29 2013 +0200
@@ -195,7 +195,8 @@
class Circulation {
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.
typedef typename Traits::Digraph Digraph;
diff -r 73c892335e74 -r 97d978243703 lemon/cost_scaling.h
--- a/lemon/cost_scaling.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/cost_scaling.h Mon Aug 05 14:03:29 2013 +0200
@@ -152,7 +152,8 @@
/// otherwise it is \c double.
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;
public:
diff -r 73c892335e74 -r 97d978243703 lemon/cplex.h
--- a/lemon/cplex.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/cplex.h Mon Aug 05 14:03:29 2013 +0200
@@ -178,7 +178,7 @@
/// This function writes the problem or the solution
/// 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.
/// Supportted formats are "MPS", "LP" and "SOL".
diff -r 73c892335e74 -r 97d978243703 lemon/dfs.h
--- a/lemon/dfs.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/dfs.h Mon Aug 05 14:03:29 2013 +0200
@@ -152,7 +152,7 @@
///The type of the paths.
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;
private:
diff -r 73c892335e74 -r 97d978243703 lemon/dijkstra.h
--- a/lemon/dijkstra.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/dijkstra.h Mon Aug 05 14:03:29 2013 +0200
@@ -227,11 +227,11 @@
typedef typename TR::HeapCrossRef HeapCrossRef;
///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;
private:
diff -r 73c892335e74 -r 97d978243703 lemon/edmonds_karp.h
--- a/lemon/edmonds_karp.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/edmonds_karp.h Mon Aug 05 14:03:29 2013 +0200
@@ -80,8 +80,8 @@
///
/// 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
/// control with feasible flow solutions. The \e source node, the \e
@@ -112,7 +112,8 @@
class EdmondsKarp {
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.
typedef typename Traits::Digraph Digraph;
diff -r 73c892335e74 -r 97d978243703 lemon/fractional_matching.h
--- a/lemon/fractional_matching.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/fractional_matching.h Mon Aug 05 14:03:29 2013 +0200
@@ -123,8 +123,8 @@
class MaxFractionalMatching {
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.
typedef typename TR::Graph Graph;
diff -r 73c892335e74 -r 97d978243703 lemon/glpk.h
--- a/lemon/glpk.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/glpk.h Mon Aug 05 14:03:29 2013 +0200
@@ -152,7 +152,7 @@
/// This function writes the problem or the solution
/// 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.
/// Supportted formats are "MPS" and "LP".
diff -r 73c892335e74 -r 97d978243703 lemon/greedy_tsp.h
--- a/lemon/greedy_tsp.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/greedy_tsp.h Mon Aug 05 14:03:29 2013 +0200
@@ -228,7 +228,7 @@
/// \brief Gives back the found tour as a path.
///
/// 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.
template <typename Path>
diff -r 73c892335e74 -r 97d978243703 lemon/hartmann_orlin_mmc.h
--- a/lemon/hartmann_orlin_mmc.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/hartmann_orlin_mmc.h Mon Aug 05 14:03:29 2013 +0200
@@ -143,11 +143,14 @@
/// \brief The path type of the found cycles
///
/// 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;
private:
diff -r 73c892335e74 -r 97d978243703 lemon/howard_mmc.h
--- a/lemon/howard_mmc.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/howard_mmc.h Mon Aug 05 14:03:29 2013 +0200
@@ -142,11 +142,11 @@
/// \brief The path type of the found cycles
///
/// 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;
/// \brief Constants for the causes of search termination.
diff -r 73c892335e74 -r 97d978243703 lemon/insertion_tsp.h
--- a/lemon/insertion_tsp.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/insertion_tsp.h Mon Aug 05 14:03:29 2013 +0200
@@ -225,7 +225,7 @@
/// \brief Gives back the found tour as a path.
///
/// 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.
template <typename Path>
diff -r 73c892335e74 -r 97d978243703 lemon/karp_mmc.h
--- a/lemon/karp_mmc.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/karp_mmc.h Mon Aug 05 14:03:29 2013 +0200
@@ -140,11 +140,11 @@
/// \brief The path type of the found cycles
///
/// 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;
private:
diff -r 73c892335e74 -r 97d978243703 lemon/lgf_reader.h
--- a/lemon/lgf_reader.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/lgf_reader.h Mon Aug 05 14:03:29 2013 +0200
@@ -1230,9 +1230,10 @@
/// \ingroup lemon_io
///
- /// \brief Return a \ref DigraphReader class
+ /// \brief Return a \ref lemon::DigraphReader "DigraphReader" class
///
- /// This function just returns a \ref DigraphReader class.
+ /// This function just returns a \ref lemon::DigraphReader
+ /// "DigraphReader" class.
///
/// With this function a digraph can be read from an
/// \ref lgf-format "LGF" file or input stream with several maps and
@@ -1252,9 +1253,10 @@
/// run();
///\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
/// \sa digraphReader(TDGR& digraph, const std::string& fn)
@@ -2108,9 +2110,9 @@
/// \ingroup lemon_io
///
- /// \brief Return a \ref GraphReader class
+ /// \brief Return a \ref lemon::GraphReader "GraphReader" class
///
- /// This function just returns a \ref GraphReader class.
+ /// This function just returns a \ref lemon::GraphReader "GraphReader" class.
///
/// With this function a graph can be read from an
/// \ref lgf-format "LGF" file or input stream with several maps and
@@ -2126,9 +2128,10 @@
/// run();
///\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
/// \sa graphReader(TGR& graph, const std::string& fn)
@@ -3174,9 +3177,10 @@
/// \ingroup lemon_io
///
- /// \brief Return a \ref BpGraphReader class
+ /// \brief Return a \ref lemon::BpGraphReader "BpGraphReader" class
///
- /// This function just returns a \ref BpGraphReader class.
+ /// This function just returns a \ref lemon::BpGraphReader
+ /// "BpGraphReader" class.
///
/// With this function a graph can be read from an
/// \ref lgf-format "LGF" file or input stream with several maps and
@@ -3192,9 +3196,10 @@
/// run();
///\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
/// \sa bpGraphReader(TBGR& graph, const std::string& fn)
diff -r 73c892335e74 -r 97d978243703 lemon/lgf_writer.h
--- a/lemon/lgf_writer.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/lgf_writer.h Mon Aug 05 14:03:29 2013 +0200
@@ -944,9 +944,10 @@
/// \ingroup lemon_io
///
- /// \brief Return a \ref DigraphWriter class
+ /// \brief Return a \ref lemon::DigraphWriter "DigraphWriter" class
///
- /// This function just returns a \ref 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
/// stream in \ref lgf-format "LGF" format with several maps and
@@ -967,9 +968,10 @@
/// run();
///\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
/// \sa digraphWriter(const TDGR& digraph, const std::string& fn)
@@ -1583,9 +1585,9 @@
/// \ingroup lemon_io
///
- /// \brief Return a \ref GraphWriter class
+ /// \brief Return a \ref lemon::GraphWriter "GraphWriter" class
///
- /// This function just returns a \ref 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
/// stream in \ref lgf-format "LGF" format with several maps and
@@ -1602,9 +1604,10 @@
/// run();
///\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
/// \sa graphWriter(const TGR& graph, const std::string& fn)
@@ -2401,9 +2404,10 @@
/// \ingroup lemon_io
///
- /// \brief Return a \ref BpGraphWriter class
+ /// \brief Return a \ref lemon::BpGraphWriter "BpGraphWriter" class
///
- /// This function just returns a \ref 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
/// stream in \ref lgf-format "LGF" format with several maps and
@@ -2420,9 +2424,10 @@
/// run();
///\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
/// \sa bpGraphWriter(const TBGR& graph, const std::string& fn)
diff -r 73c892335e74 -r 97d978243703 lemon/lp_base.h
--- a/lemon/lp_base.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/lp_base.h Mon Aug 05 14:03:29 2013 +0200
@@ -1007,7 +1007,7 @@
public:
- ///\e
+ ///\e \
class UnsupportedFormatError : public Exception
{
std::string _format;
diff -r 73c892335e74 -r 97d978243703 lemon/min_cost_arborescence.h
--- a/lemon/min_cost_arborescence.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/min_cost_arborescence.h Mon Aug 05 14:03:29 2013 +0200
@@ -128,7 +128,7 @@
class MinCostArborescence {
public:
- /// \brief The \ref MinCostArborescenceDefaultTraits "traits class"
+ /// \brief The \ref lemon::MinCostArborescenceDefaultTraits "traits class"
/// of the algorithm.
typedef TR Traits;
/// The type of the underlying digraph.
diff -r 73c892335e74 -r 97d978243703 lemon/nearest_neighbor_tsp.h
--- a/lemon/nearest_neighbor_tsp.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/nearest_neighbor_tsp.h Mon Aug 05 14:03:29 2013 +0200
@@ -215,7 +215,7 @@
/// \brief Gives back the found tour as a path.
///
/// 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.
template <typename Path>
diff -r 73c892335e74 -r 97d978243703 lemon/opt2_tsp.h
--- a/lemon/opt2_tsp.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/opt2_tsp.h Mon Aug 05 14:03:29 2013 +0200
@@ -252,7 +252,7 @@
/// \brief Gives back the found tour as a path.
///
/// 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.
template <typename Path>
diff -r 73c892335e74 -r 97d978243703 lemon/preflow.h
--- a/lemon/preflow.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/preflow.h Mon Aug 05 14:03:29 2013 +0200
@@ -134,7 +134,7 @@
class Preflow {
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.
typedef typename Traits::Digraph Digraph;
diff -r 73c892335e74 -r 97d978243703 lemon/suurballe.h
--- a/lemon/suurballe.h Tue Jul 30 15:54:46 2013 +0200
+++ b/lemon/suurballe.h Mon Aug 05 14:03:29 2013 +0200
@@ -137,7 +137,7 @@
/// The heap type used for internal Dijkstra computations.
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;
private: