COIN-OR::LEMON - Graph Library

Changeset 1250:97d978243703 in lemon


Ignore:
Timestamp:
08/05/13 14:03:29 (6 years ago)
Author:
Alpar Juttner <alpar@…>
Branch:
default
Phase:
public
Message:

Fix unresolved doc references (#459)

Files:
27 edited

Legend:

Unmodified
Added
Removed
  • doc/Doxyfile.in

    r1221 r1250  
    100100                         "@abs_top_srcdir@/tools" \
    101101                         "@abs_top_srcdir@/test/test_tools.h" \
    102                          "@abs_top_builddir@/doc/mainpage.dox" \
    103                          "@abs_top_builddir@/doc/references.dox"
     102                         "@abs_top_builddir@/doc/mainpage.dox"
    104103INPUT_ENCODING         = UTF-8
    105104FILE_PATTERNS          = *.h \
  • doc/lgf.dox

    r1192 r1250  
    6565
    6666The \e LGF files can also contain bipartite graphs, in this case a
    67 \c @red_nodes and a \c @blue_nodes sections describe the node set of the
     67\c \@red_nodes and a \c \@blue_nodes sections describe the node set of the
    6868graph. If a map is in both of these sections, then it can be used as a
    6969regular node map.
  • lemon/bellman_ford.h

    r960 r1250  
    201201    /// The type of the paths.
    202202    typedef PredMapPath<Digraph, PredMap> Path;
    203     ///\brief The \ref BellmanFordDefaultOperationTraits
     203    ///\brief The \ref lemon::BellmanFordDefaultOperationTraits
    204204    /// "operation traits class" of the algorithm.
    205205    typedef typename TR::OperationTraits OperationTraits;
    206206
    207     ///The \ref BellmanFordDefaultTraits "traits class" of the algorithm.
     207    ///\brief The \ref lemon::BellmanFordDefaultTraits "traits class"
     208    ///of the algorithm.
    208209    typedef TR Traits;
    209210
  • lemon/bfs.h

    r1127 r1250  
    153153    typedef PredMapPath<Digraph, PredMap> Path;
    154154
    155     ///The \ref BfsDefaultTraits "traits class" of the algorithm.
     155    ///The \ref lemon::BfsDefaultTraits "traits class" of the algorithm.
    156156    typedef TR Traits;
    157157
  • lemon/capacity_scaling.h

    r1241 r1250  
    119119    typedef typename TR::Heap Heap;
    120120
    121     /// The \ref CapacityScalingDefaultTraits "traits class" of the algorithm
     121    /// \brief The \ref lemon::CapacityScalingDefaultTraits "traits class"
     122    /// of the algorithm
    122123    typedef TR Traits;
    123124
  • lemon/christofides_tsp.h

    r1205 r1250  
    232232      ///
    233233      /// This function copies the found tour as a list of arcs/edges into
    234       /// the given \ref concept::Path "path structure".
     234      /// the given \ref lemon::concepts::Path "path structure".
    235235      ///
    236236      /// \pre run() must be called before using this function.
  • lemon/circulation.h

    r1159 r1250  
    196196  public:
    197197
    198     ///The \ref CirculationDefaultTraits "traits class" of the algorithm.
     198    /// \brief The \ref lemon::CirculationDefaultTraits "traits class"
     199    /// of the algorithm.
    199200    typedef TR Traits;
    200201    ///The type of the digraph the algorithm runs on.
  • lemon/cost_scaling.h

    r1241 r1250  
    153153    typedef typename TR::LargeCost LargeCost;
    154154
    155     /// The \ref CostScalingDefaultTraits "traits class" of the algorithm
     155    /// \brief The \ref lemon::CostScalingDefaultTraits "traits class"
     156    /// of the algorithm
    156157    typedef TR Traits;
    157158
  • lemon/cplex.h

    r1231 r1250  
    179179    /// to a file in the given format.
    180180    /// Trying to write in an unsupported format will trigger
    181     /// \ref UnsupportedFormatError.
     181    /// \ref lemon::LpBase::UnsupportedFormatError "UnsupportedFormatError".
    182182    /// \param file The file path
    183183    /// \param format The output file format.
  • lemon/dfs.h

    r1161 r1250  
    153153    typedef PredMapPath<Digraph, PredMap> Path;
    154154
    155     ///The \ref DfsDefaultTraits "traits class" of the algorithm.
     155    ///The \ref lemon::DfsDefaultTraits "traits class" of the algorithm.
    156156    typedef TR Traits;
    157157
  • lemon/dijkstra.h

    r956 r1250  
    228228    ///The heap type used by the algorithm.
    229229    typedef typename TR::Heap Heap;
    230     ///\brief The \ref DijkstraDefaultOperationTraits "operation traits class"
    231     ///of the algorithm.
     230    /// \brief The \ref lemon::DijkstraDefaultOperationTraits
     231    /// "operation traits class" of the algorithm.
    232232    typedef typename TR::OperationTraits OperationTraits;
    233233
    234     ///The \ref DijkstraDefaultTraits "traits class" of the algorithm.
     234    ///The \ref lemon::DijkstraDefaultTraits "traits class" of the algorithm.
    235235    typedef TR Traits;
    236236
  • lemon/edmonds_karp.h

    r1229 r1250  
    8181  /// This class provides an implementation of the \e Edmonds-Karp \e
    8282  /// algorithm producing a \ref max_flow "flow of maximum value" in a
    83   /// digraph \ref clrs01algorithms, \ref amo93networkflows,
    84   /// \ref edmondskarp72theoretical.
     83  /// digraph \cite clrs01algorithms, \cite amo93networkflows,
     84  /// \cite edmondskarp72theoretical.
    8585  /// The Edmonds-Karp algorithm is slower than the Preflow
    8686  /// algorithm, but it has an advantage of the step-by-step execution
     
    113113  public:
    114114
    115     /// The \ref EdmondsKarpDefaultTraits "traits class" of the algorithm.
     115    /// \brief The \ref lemon::EdmondsKarpDefaultTraits "traits class"
     116    /// of the algorithm.
    116117    typedef TR Traits;
    117118    /// The type of the digraph the algorithm runs on.
  • lemon/fractional_matching.h

    r956 r1250  
    124124  public:
    125125
    126     /// \brief The \ref MaxFractionalMatchingDefaultTraits "traits
    127     /// class" of the algorithm.
     126    /// \brief The \ref lemon::MaxFractionalMatchingDefaultTraits
     127    /// "traits class" of the algorithm.
    128128    typedef TR Traits;
    129129    /// The type of the graph the algorithm runs on.
  • lemon/glpk.h

    r1231 r1250  
    153153    /// to a file in the given format.
    154154    /// Trying to write in an unsupported format will trigger
    155     /// \ref UnsupportedFormatError.
     155    /// \ref LpBase::UnsupportedFormatError.
    156156    /// \param file The file path
    157157    /// \param format The output file format.
  • lemon/greedy_tsp.h

    r1205 r1250  
    229229      ///
    230230      /// This function copies the found tour as a list of arcs/edges into
    231       /// the given \ref concept::Path "path structure".
     231      /// the given \ref lemon::concepts::Path "path structure".
    232232      ///
    233233      /// \pre run() must be called before using this function.
  • lemon/hartmann_orlin_mmc.h

    r1221 r1250  
    144144    ///
    145145    /// The path type of the found cycles.
    146     /// Using the \ref HartmannOrlinMmcDefaultTraits "default traits class",
     146    /// Using the \ref lemon::HartmannOrlinMmcDefaultTraits
     147    /// "default traits class",
    147148    /// it is \ref lemon::Path "Path<Digraph>".
    148149    typedef typename TR::Path Path;
    149150
    150     /// The \ref HartmannOrlinMmcDefaultTraits "traits class" of the algorithm
     151    /// \brief The
     152    /// \ref lemon::HartmannOrlinMmcDefaultTraits "traits class"
     153    /// of the algorithm
    151154    typedef TR Traits;
    152155
  • lemon/howard_mmc.h

    r1221 r1250  
    143143    ///
    144144    /// The path type of the found cycles.
    145     /// Using the \ref HowardMmcDefaultTraits "default traits class",
     145    /// Using the \ref lemon::HowardMmcDefaultTraits "default traits class",
    146146    /// it is \ref lemon::Path "Path<Digraph>".
    147147    typedef typename TR::Path Path;
    148148
    149     /// The \ref HowardMmcDefaultTraits "traits class" of the algorithm
     149    /// The \ref lemon::HowardMmcDefaultTraits "traits class" of the algorithm
    150150    typedef TR Traits;
    151151
  • lemon/insertion_tsp.h

    r1205 r1250  
    226226      ///
    227227      /// This function copies the found tour as a list of arcs/edges into
    228       /// the given \ref concept::Path "path structure".
     228      /// the given \ref lemon::concepts::Path "path structure".
    229229      ///
    230230      /// \pre run() must be called before using this function.
  • lemon/karp_mmc.h

    r1221 r1250  
    141141    ///
    142142    /// The path type of the found cycles.
    143     /// Using the \ref KarpMmcDefaultTraits "default traits class",
     143    /// Using the \ref lemon::KarpMmcDefaultTraits "default traits class",
    144144    /// it is \ref lemon::Path "Path<Digraph>".
    145145    typedef typename TR::Path Path;
    146146
    147     /// The \ref KarpMmcDefaultTraits "traits class" of the algorithm
     147    /// The \ref lemon::KarpMmcDefaultTraits "traits class" of the algorithm
    148148    typedef TR Traits;
    149149
  • lemon/lgf_reader.h

    r1198 r1250  
    12311231  /// \ingroup lemon_io
    12321232  ///
    1233   /// \brief Return a \ref DigraphReader class
    1234   ///
    1235   /// This function just returns a \ref DigraphReader class.
     1233  /// \brief Return a \ref lemon::DigraphReader "DigraphReader" class
     1234  ///
     1235  /// This function just returns a \ref lemon::DigraphReader
     1236  /// "DigraphReader" class.
    12361237  ///
    12371238  /// With this function a digraph can be read from an
     
    12531254  ///\endcode
    12541255  ///
    1255   /// For a complete documentation, please see the \ref DigraphReader
     1256  /// For a complete documentation, please see the
     1257  /// \ref lemon::DigraphReader "DigraphReader"
    12561258  /// class documentation.
    1257   /// \warning Don't forget to put the \ref DigraphReader::run() "run()"
     1259  /// \warning Don't forget to put the \ref lemon::DigraphReader::run() "run()"
    12581260  /// to the end of the parameter list.
    12591261  /// \relates DigraphReader
     
    21092111  /// \ingroup lemon_io
    21102112  ///
    2111   /// \brief Return a \ref GraphReader class
    2112   ///
    2113   /// This function just returns a \ref GraphReader class.
     2113  /// \brief Return a \ref lemon::GraphReader "GraphReader" class
     2114  ///
     2115  /// This function just returns a \ref lemon::GraphReader "GraphReader" class.
    21142116  ///
    21152117  /// With this function a graph can be read from an
     
    21272129  ///\endcode
    21282130  ///
    2129   /// For a complete documentation, please see the \ref GraphReader
     2131  /// For a complete documentation, please see the
     2132  /// \ref lemon::GraphReader "GraphReader"
    21302133  /// class documentation.
    2131   /// \warning Don't forget to put the \ref GraphReader::run() "run()"
     2134  /// \warning Don't forget to put the \ref lemon::GraphReader::run() "run()"
    21322135  /// to the end of the parameter list.
    21332136  /// \relates GraphReader
     
    31753178  /// \ingroup lemon_io
    31763179  ///
    3177   /// \brief Return a \ref BpGraphReader class
    3178   ///
    3179   /// This function just returns a \ref BpGraphReader class.
     3180  /// \brief Return a \ref lemon::BpGraphReader "BpGraphReader" class
     3181  ///
     3182  /// This function just returns a \ref lemon::BpGraphReader
     3183  /// "BpGraphReader" class.
    31803184  ///
    31813185  /// With this function a graph can be read from an
     
    31933197  ///\endcode
    31943198  ///
    3195   /// For a complete documentation, please see the \ref BpGraphReader
     3199  /// For a complete documentation, please see the
     3200  /// \ref lemon::BpGraphReader "BpGraphReader"
    31963201  /// class documentation.
    3197   /// \warning Don't forget to put the \ref BpGraphReader::run() "run()"
     3202  /// \warning Don't forget to put the \ref lemon::BpGraphReader::run() "run()"
    31983203  /// to the end of the parameter list.
    31993204  /// \relates BpGraphReader
  • lemon/lgf_writer.h

    r1198 r1250  
    945945  /// \ingroup lemon_io
    946946  ///
    947   /// \brief Return a \ref DigraphWriter class
    948   ///
    949   /// This function just returns a \ref DigraphWriter class.
     947  /// \brief Return a \ref lemon::DigraphWriter "DigraphWriter" class
     948  ///
     949  /// This function just returns a \ref lemon::DigraphWriter
     950  /// "DigraphWriter" class.
    950951  ///
    951952  /// With this function a digraph can be write to a file or output
     
    968969  ///\endcode
    969970  ///
    970   /// For a complete documentation, please see the \ref DigraphWriter
     971  /// For a complete documentation, please see the
     972  /// \ref lemon::DigraphWriter "DigraphWriter"
    971973  /// class documentation.
    972   /// \warning Don't forget to put the \ref DigraphWriter::run() "run()"
     974  /// \warning Don't forget to put the \ref lemon::DigraphWriter::run() "run()"
    973975  /// to the end of the parameter list.
    974976  /// \relates DigraphWriter
     
    15841586  /// \ingroup lemon_io
    15851587  ///
    1586   /// \brief Return a \ref GraphWriter class
    1587   ///
    1588   /// This function just returns a \ref GraphWriter class.
     1588  /// \brief Return a \ref lemon::GraphWriter "GraphWriter" class
     1589  ///
     1590  /// This function just returns a \ref lemon::GraphWriter "GraphWriter" class.
    15891591  ///
    15901592  /// With this function a graph can be write to a file or output
     
    16031605  ///\endcode
    16041606  ///
    1605   /// For a complete documentation, please see the \ref GraphWriter
     1607  /// For a complete documentation, please see the
     1608  /// \ref lemon::GraphWriter "GraphWriter"
    16061609  /// class documentation.
    1607   /// \warning Don't forget to put the \ref GraphWriter::run() "run()"
     1610  /// \warning Don't forget to put the \ref lemon::GraphWriter::run() "run()"
    16081611  /// to the end of the parameter list.
    16091612  /// \relates GraphWriter
     
    24022405  /// \ingroup lemon_io
    24032406  ///
    2404   /// \brief Return a \ref BpGraphWriter class
    2405   ///
    2406   /// This function just returns a \ref BpGraphWriter class.
     2407  /// \brief Return a \ref lemon::BpGraphWriter "BpGraphWriter" class
     2408  ///
     2409  /// This function just returns a \ref lemon::BpGraphWriter
     2410  /// "BpGraphWriter" class.
    24072411  ///
    24082412  /// With this function a bipartite graph can be write to a file or output
     
    24212425  ///\endcode
    24222426  ///
    2423   /// For a complete documentation, please see the \ref BpGraphWriter
     2427  /// For a complete documentation, please see the
     2428  /// \ref lemon::BpGraphWriter "BpGraphWriter"
    24242429  /// class documentation.
    2425   /// \warning Don't forget to put the \ref BpGraphWriter::run() "run()"
     2430  /// \warning Don't forget to put the \ref lemon::BpGraphWriter::run() "run()"
    24262431  /// to the end of the parameter list.
    24272432  /// \relates BpGraphWriter
  • lemon/lp_base.h

    r1231 r1250  
    10081008  public:
    10091009
    1010     ///\e
     1010    ///\e \
    10111011    class UnsupportedFormatError : public Exception
    10121012    {
  • lemon/min_cost_arborescence.h

    r956 r1250  
    129129  public:
    130130
    131     /// \brief The \ref MinCostArborescenceDefaultTraits "traits class"
     131    /// \brief The \ref lemon::MinCostArborescenceDefaultTraits "traits class"
    132132    /// of the algorithm.
    133133    typedef TR Traits;
  • lemon/nearest_neighbor_tsp.h

    r1205 r1250  
    216216      ///
    217217      /// This function copies the found tour as a list of arcs/edges into
    218       /// the given \ref concept::Path "path structure".
     218      /// the given \ref lemon::concepts::Path "path structure".
    219219      ///
    220220      /// \pre run() must be called before using this function.
  • lemon/opt2_tsp.h

    r1205 r1250  
    253253      ///
    254254      /// This function copies the found tour as a list of arcs/edges into
    255       /// the given \ref concept::Path "path structure".
     255      /// the given \ref lemon::concepts::Path "path structure".
    256256      ///
    257257      /// \pre run() must be called before using this function.
  • lemon/preflow.h

    r1221 r1250  
    135135  public:
    136136
    137     ///The \ref PreflowDefaultTraits "traits class" of the algorithm.
     137    ///The \ref lemon::PreflowDefaultTraits "traits class" of the algorithm.
    138138    typedef TR Traits;
    139139    ///The type of the digraph the algorithm runs on.
  • lemon/suurballe.h

    r956 r1250  
    138138    typedef typename TR::Heap Heap;
    139139
    140     /// The \ref SuurballeDefaultTraits "traits class" of the algorithm.
     140    /// The \ref lemon::SuurballeDefaultTraits "traits class" of the algorithm.
    141141    typedef TR Traits;
    142142
Note: See TracChangeset for help on using the changeset viewer.