# Changeset 1631:e15162d8eca1 in lemon-0.x

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

Fixed most (but not all) of Doxygen warnings

Files:
13 edited

Unmodified
Removed

• ## doc/graphs.dox

 r1200 \ref lemon::concept::ExtendableGraph "ExtendableGraph" concept, so you cannot delete individual edges or nodes. \li \ref lemon::SymListGraph "SymListGraph" and \ref lemon::SymSmartGraph "SymSmartGraph" classes are very similar to \ref lemon::ListGraph "ListGraph" and \ref lemon::SmartGraph "SmartGraph". The difference is that whenever you add a new edge to the graph, it actually adds a pair of oppositely directed edges. They are linked together so it is possible to access the counterpart of an edge. An even more important feature is that using these classes you can also attach data to the edges in such a way that the stored data are shared by the edge pairs. \li \ref lemon::FullGraph "FullGraph" implements a complete graph. It is a

• ## lemon/bfs.h

 r1624 ///if \c v is unreachable from the root(s) or \c v is a root. The ///shortest path tree used here is equal to the shortest path tree used in ///\ref predNode(Node v). ///\ref predNode(). ///\pre Either \ref run() or \ref start() must be called before using ///this function. ///if \c v itself a root. ///The shortest path tree used here is equal to the shortest path ///tree used in \ref pred(Node v). ///tree used in \ref pred(). ///\pre Either \ref run() or \ref start() must be called before ///using this function.
• ## lemon/concept/graph.h

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

 r1627 /// This class describes the common interface of the graph maps /// (NodeMap, EdgeMap), that is \ref maps-pages "maps" which can be used to /// (NodeMap, EdgeMap), that is \ref maps-page "maps" which can be used to /// associate data to graph descriptors (nodes or edges). template
• ## lemon/concept/undir_graph.h

 r1630 /// /// In LEMON undirected graphs also fulfill the concept of directed /// graphs (\ref lemon::concept::Graph "Graph Concept"). For /// graphs (\ref lemon::concept::StaticGraph "Graph Concept"). For /// explanation of this and more see also the page \ref undir_graphs, /// a tutorial about undirected graphs. /// This constructor sets the iterator to the first edge of \c g. ///@param g the graph EdgeIt(const UndirGraph&) { } EdgeIt(const UndirGraph &g) { } /// Edge -> EdgeIt conversion ///@param n the node ///@param g the graph OutEdgeIt(const UndirGraph&, const Node&) { } OutEdgeIt(const UndirGraph& n, const Node& g) { } /// Edge -> OutEdgeIt conversion ///@param n the node ///@param g the graph InEdgeIt(const UndirGraph&, const Node&) { } InEdgeIt(const UndirGraph& g, const Node& n) { } /// Edge -> InEdgeIt conversion
• ## lemon/dfs.h

 r1540 ///if \c v is unreachable from the root(s) or \c v is a root. The ///%DFS tree used here is equal to the %DFS tree used in ///\ref predNode(Node v). ///\ref predNode(). ///\pre Either \ref run() or \ref start() must be called before using ///this function. ///if \c v itself a root. ///The %DFS tree used here is equal to the %DFS ///tree used in \ref pred(Node v). ///tree used in \ref pred(). ///\pre Either \ref run() or \ref start() must be called before ///using this function.
• ## lemon/dijkstra.h

 r1536 ///if \c v is unreachable from the root or if \c v=s. The ///shortest path tree used here is equal to the shortest path tree used in ///\ref predNode(Node v).  \pre \ref run() must be called before using ///\ref predNode().  \pre \ref run() must be called before using ///this function. ///\todo predEdge could be a better name. ///root to \c /v. It is INVALID if \c v is unreachable from the root or if ///\c v=s. The shortest path tree used here is equal to the shortest path ///tree used in \ref pred(Node v).  \pre \ref run() must be called before ///tree used in \ref pred().  \pre \ref run() must be called before ///using this function. Node predNode(Node v) const { return (*_pred)[v]==INVALID ? INVALID:

 r1627 /// /// \param _Graph The type of the graph which shares its node set with /// this class. Its interface must conform to the \ref skeleton::StaticGraph /// this class. Its interface must conform to the \ref concept::StaticGraph /// "StaticGraph" concept. /// /// In the edge extension and removing it conforms to the /// \ref skeleton::ExtendableGraph "ExtendableGraph" concept. /// \ref concept::ExtendableGraph "ExtendableGraph" concept. template class NewEdgeSetAdaptor : /// /// \param _Graph The type of the graph which shares its node set with /// this class. Its interface must conform to the \ref skeleton::StaticGraph /// this class. Its interface must conform to the \ref concept::StaticGraph /// "StaticGraph" concept. /// /// In the edge extension and removing it conforms to the /// \ref skeleton::ExtendableGraph "ExtendableGraph" concept. /// \ref concept::ExtendableGraph "ExtendableGraph" concept. template class NewUndirEdgeSetAdaptor :
• ## lemon/kruskal.h

 r1603 /// \param g The graph the algorithm runs on. /// It can be either \ref concept::StaticGraph "directed" or /// \ref concept::UndirStaticGraph "undirected". /// \ref concept::UndirGraph "undirected". /// If the graph is directed, the algorithm consider it to be /// undirected by disregarding the direction of the edges. /// \return The cost of the found tree. /// /// \warning If kruskal is run on an \ref undirected graph, be sure that the /// \warning If kruskal is run on an /// \ref lemon::concept::UndirGraph "undirected graph", be sure that the /// map storing the tree is also undirected /// (e.g. UndirListGraph::UndirEdgeMap, otherwise the values of the
• ## lemon/preflow.h

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

 r1537 /// Maximum node ID. ///\sa id(Node) int maxId(Node = INVALID) const { return nodes.size()-1; } int maxId(Node) const { return nodes.size()-1; } /// Maximum edge ID. /// Maximum edge ID. ///\sa id(Edge) int maxId(Edge = INVALID) const { return edges.size()-1; } int maxId(Edge) const { return edges.size()-1; } Node source(Edge e) const { return edges[e.n].source; } /// The ID of a valid Node is a nonnegative integer not greater than /// \ref maxNodeId(). The range of the ID's is not surely continuous /// and the greatest node ID can be actually less then \ref maxNodeId(). /// \ref maxId(Node). The range of the ID's is not surely continuous /// and the greatest node ID can be actually less then \ref maxId(Node). /// /// The ID of the \ref INVALID node is -1. /// The ID of a valid Edge is a nonnegative integer not greater than /// \ref maxEdgeId(). The range of the ID's is not surely continuous /// and the greatest edge ID can be actually less then \ref maxEdgeId(). /// \ref maxId(Edge). The range of the ID's is not surely continuous /// and the greatest edge ID can be actually less then \ref maxId(Edge). /// /// The ID of the \ref INVALID edge is -1.
Note: See TracChangeset for help on using the changeset viewer.