COIN-OR::LEMON - Graph Library

Changeset 1631:e15162d8eca1 in lemon-0.x for lemon


Ignore:
Timestamp:
08/16/05 21:06:59 (15 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2139
Message:

Fixed most (but not all) of Doxygen warnings

Location:
lemon
Files:
10 edited

Legend:

Unmodified
Added
Removed
  • lemon/bfs.h

    r1624 r1631  
    699699    ///if \c v is unreachable from the root(s) or \c v is a root. The
    700700    ///shortest path tree used here is equal to the shortest path tree used in
    701     ///\ref predNode(Node v).
     701    ///\ref predNode().
    702702    ///\pre Either \ref run() or \ref start() must be called before using
    703703    ///this function.
     
    714714    ///if \c v itself a root.
    715715    ///The shortest path tree used here is equal to the shortest path
    716     ///tree used in \ref pred(Node v).
     716    ///tree used in \ref pred().
    717717    ///\pre Either \ref run() or \ref start() must be called before
    718718    ///using this function.
  • lemon/concept/graph.h

    r1630 r1631  
    405405        /// This constructor sets the iterator to the first edge of \c g.
    406406        ///@param g the graph
    407         EdgeIt(const StaticGraph&) { }
     407        EdgeIt(const StaticGraph& g) { }
    408408        /// Edge -> EdgeIt conversion
    409409
  • lemon/concept/graph_component.h

    r1627 r1631  
    764764
    765765    /// This class describes the common interface of the graph maps
    766     /// (NodeMap, EdgeMap), that is \ref maps-pages "maps" which can be used to
     766    /// (NodeMap, EdgeMap), that is \ref maps-page "maps" which can be used to
    767767    /// associate data to graph descriptors (nodes or edges).
    768768    template <typename Graph, typename Item, typename _Value>
  • lemon/concept/undir_graph.h

    r1630 r1631  
    233233    ///
    234234    /// In LEMON undirected graphs also fulfill the concept of directed
    235     /// graphs (\ref lemon::concept::Graph "Graph Concept"). For
     235    /// graphs (\ref lemon::concept::StaticGraph "Graph Concept"). For
    236236    /// explanation of this and more see also the page \ref undir_graphs,
    237237    /// a tutorial about undirected graphs.
     
    558558        /// This constructor sets the iterator to the first edge of \c g.
    559559        ///@param g the graph
    560         EdgeIt(const UndirGraph&) { }
     560        EdgeIt(const UndirGraph &g) { }
    561561        /// Edge -> EdgeIt conversion
    562562
     
    606606        ///@param n the node
    607607        ///@param g the graph
    608         OutEdgeIt(const UndirGraph&, const Node&) { }
     608        OutEdgeIt(const UndirGraph& n, const Node& g) { }
    609609        /// Edge -> OutEdgeIt conversion
    610610
     
    655655        ///@param n the node
    656656        ///@param g the graph
    657         InEdgeIt(const UndirGraph&, const Node&) { }
     657        InEdgeIt(const UndirGraph& g, const Node& n) { }
    658658        /// Edge -> InEdgeIt conversion
    659659
  • lemon/dfs.h

    r1540 r1631  
    709709    ///if \c v is unreachable from the root(s) or \c v is a root. The
    710710    ///%DFS tree used here is equal to the %DFS tree used in
    711     ///\ref predNode(Node v).
     711    ///\ref predNode().
    712712    ///\pre Either \ref run() or \ref start() must be called before using
    713713    ///this function.
     
    724724    ///if \c v itself a root.
    725725    ///The %DFS tree used here is equal to the %DFS
    726     ///tree used in \ref pred(Node v).
     726    ///tree used in \ref pred().
    727727    ///\pre Either \ref run() or \ref start() must be called before
    728728    ///using this function.
  • lemon/dijkstra.h

    r1536 r1631  
    703703    ///if \c v is unreachable from the root or if \c v=s. The
    704704    ///shortest path tree used here is equal to the shortest path tree used in
    705     ///\ref predNode(Node v).  \pre \ref run() must be called before using
     705    ///\ref predNode().  \pre \ref run() must be called before using
    706706    ///this function.
    707707    ///\todo predEdge could be a better name.
     
    714714    ///root to \c /v. It is INVALID if \c v is unreachable from the root or if
    715715    ///\c v=s. The shortest path tree used here is equal to the shortest path
    716     ///tree used in \ref pred(Node v).  \pre \ref run() must be called before
     716    ///tree used in \ref pred().  \pre \ref run() must be called before
    717717    ///using this function.
    718718    Node predNode(Node v) const { return (*_pred)[v]==INVALID ? INVALID:
  • lemon/graph_adaptor.h

    r1627 r1631  
    14211421  ///
    14221422  /// \param _Graph The type of the graph which shares its node set with
    1423   /// this class. Its interface must conform to the \ref skeleton::StaticGraph
     1423  /// this class. Its interface must conform to the \ref concept::StaticGraph
    14241424  /// "StaticGraph" concept.
    14251425  ///
    14261426  /// In the edge extension and removing it conforms to the
    1427   /// \ref skeleton::ExtendableGraph "ExtendableGraph" concept.
     1427  /// \ref concept::ExtendableGraph "ExtendableGraph" concept.
    14281428  template <typename _Graph>
    14291429  class NewEdgeSetAdaptor :
     
    15131513  ///
    15141514  /// \param _Graph The type of the graph which shares its node set with
    1515   /// this class. Its interface must conform to the \ref skeleton::StaticGraph
     1515  /// this class. Its interface must conform to the \ref concept::StaticGraph
    15161516  /// "StaticGraph" concept.
    15171517  ///
    15181518  /// In the edge extension and removing it conforms to the
    1519   /// \ref skeleton::ExtendableGraph "ExtendableGraph" concept.
     1519  /// \ref concept::ExtendableGraph "ExtendableGraph" concept.
    15201520  template <typename _Graph>
    15211521  class NewUndirEdgeSetAdaptor :
  • lemon/kruskal.h

    r1603 r1631  
    5252  /// \param g The graph the algorithm runs on.
    5353  /// It can be either \ref concept::StaticGraph "directed" or
    54   /// \ref concept::UndirStaticGraph "undirected".
     54  /// \ref concept::UndirGraph "undirected".
    5555  /// If the graph is directed, the algorithm consider it to be
    5656  /// undirected by disregarding the direction of the edges.
     
    8989  /// \return The cost of the found tree.
    9090  ///
    91   /// \warning If kruskal is run on an \ref undirected graph, be sure that the
     91  /// \warning If kruskal is run on an
     92  /// \ref lemon::concept::UndirGraph "undirected graph", be sure that the
    9293  /// map storing the tree is also undirected
    9394  /// (e.g. UndirListGraph::UndirEdgeMap<bool>, otherwise the values of the
  • lemon/preflow.h

    r1435 r1631  
    284284
    285285    ///The preflow algorithm consists of two phases, this method runs
    286     ///the second phase. After calling \ref phase1 and then \ref
    287     ///phase2, \ref flow contains a maximum flow, \ref flowValue
     286    ///the second phase. After calling \ref phase1() and then
     287    ///\ref phase2(),
     288    /// \ref flowMap() return a maximum flow, \ref flowValue
    288289    ///returns the value of a maximum flow, \ref minCut returns a
    289290    ///minimum cut, while the methods \ref minMinCut and \ref
  • lemon/smart_graph.h

    r1537 r1631  
    9090    /// Maximum node ID.
    9191    ///\sa id(Node)
    92     int maxId(Node = INVALID) const { return nodes.size()-1; }
     92    int maxId(Node) const { return nodes.size()-1; }
    9393    /// Maximum edge ID.
    9494   
    9595    /// Maximum edge ID.
    9696    ///\sa id(Edge)
    97     int maxId(Edge = INVALID) const { return edges.size()-1; }
     97    int maxId(Edge) const { return edges.size()-1; }
    9898
    9999    Node source(Edge e) const { return edges[e.n].source; }
     
    103103   
    104104    /// The ID of a valid Node is a nonnegative integer not greater than
    105     /// \ref maxNodeId(). The range of the ID's is not surely continuous
    106     /// and the greatest node ID can be actually less then \ref maxNodeId().
     105    /// \ref maxId(Node). The range of the ID's is not surely continuous
     106    /// and the greatest node ID can be actually less then \ref maxId(Node).
    107107    ///
    108108    /// The ID of the \ref INVALID node is -1.
     
    112112   
    113113    /// The ID of a valid Edge is a nonnegative integer not greater than
    114     /// \ref maxEdgeId(). The range of the ID's is not surely continuous
    115     /// and the greatest edge ID can be actually less then \ref maxEdgeId().
     114    /// \ref maxId(Edge). The range of the ID's is not surely continuous
     115    /// and the greatest edge ID can be actually less then \ref maxId(Edge).
    116116    ///
    117117    /// The ID of the \ref INVALID edge is -1.
Note: See TracChangeset for help on using the changeset viewer.