[Lemon-commits] [lemon_svn] alpar: r2138 - in hugo/trunk: demo lemon lemon/concept
Lemon SVN
svn at lemon.cs.elte.hu
Mon Nov 6 20:50:26 CET 2006
Author: alpar
Date: Tue Aug 16 18:44:57 2005
New Revision: 2138
Modified:
hugo/trunk/demo/graph_to_eps_demo.cc
hugo/trunk/lemon/concept/graph.h
hugo/trunk/lemon/concept/undir_graph.h
hugo/trunk/lemon/utility.h
Log:
Doc changes:
- True and False got documented
- Graph "developper interface" documentation switched off
- minor fix in graph_to_eps_demo.cc
Modified: hugo/trunk/demo/graph_to_eps_demo.cc
==============================================================================
--- hugo/trunk/demo/graph_to_eps_demo.cc (original)
+++ hugo/trunk/demo/graph_to_eps_demo.cc Tue Aug 16 18:44:57 2005
@@ -24,7 +24,7 @@
/// graphToEps(), and showing how to draw directed/undirected graphs,
/// how to handle parallel egdes, how to change the properties (like
/// color, shape, size, title etc.) of nodes and edges individually
-/// using appropriate \ref maps-page "graphmapfactory".
+/// using appropriate \ref maps-page "graph maps".
#include <cmath>
Modified: hugo/trunk/lemon/concept/graph.h
==============================================================================
--- hugo/trunk/lemon/concept/graph.h (original)
+++ hugo/trunk/lemon/concept/graph.h Tue Aug 16 18:44:57 2005
@@ -427,53 +427,53 @@
///
Node source(Edge) const { return INVALID; }
- /// Gives back the first Node in the iterating order.
+// /// Gives back the first Node in the iterating order.
- /// Gives back the first Node in the iterating order.
- ///
+// /// Gives back the first Node in the iterating order.
+// ///
void first(Node&) const {}
- /// Gives back the next Node in the iterating order.
+// /// Gives back the next Node in the iterating order.
- /// Gives back the next Node in the iterating order.
- ///
+// /// Gives back the next Node in the iterating order.
+// ///
void next(Node&) const {}
- /// Gives back the first Edge in the iterating order.
+// /// Gives back the first Edge in the iterating order.
- /// Gives back the first Edge in the iterating order.
- ///
+// /// Gives back the first Edge in the iterating order.
+// ///
void first(Edge&) const {}
- /// Gives back the next Edge in the iterating order.
+// /// Gives back the next Edge in the iterating order.
- /// Gives back the next Edge in the iterating order.
- ///
+// /// Gives back the next Edge in the iterating order.
+// ///
void next(Edge&) const {}
- /// Gives back the first of the Edges point to the given Node.
+// /// Gives back the first of the Edges point to the given Node.
- /// Gives back the first of the Edges point to the given Node.
- ///
+// /// Gives back the first of the Edges point to the given Node.
+// ///
void firstIn(Edge&, const Node&) const {}
- /// Gives back the next of the Edges points to the given Node.
+// /// Gives back the next of the Edges points to the given Node.
- /// Gives back the next of the Edges points to the given Node.
- ///
+// /// Gives back the next of the Edges points to the given Node.
+// ///
void nextIn(Edge&) const {}
- /// Gives back the first of the Edges start from the given Node.
+// /// Gives back the first of the Edges start from the given Node.
- /// Gives back the first of the Edges start from the given Node.
- ///
+// /// Gives back the first of the Edges start from the given Node.
+// ///
void firstOut(Edge&, const Node&) const {}
- /// Gives back the next of the Edges start from the given Node.
+// /// Gives back the next of the Edges start from the given Node.
- /// Gives back the next of the Edges start from the given Node.
- ///
+// /// Gives back the next of the Edges start from the given Node.
+// ///
void nextOut(Edge&) const {}
/// \brief The base node of the iterator.
@@ -511,6 +511,7 @@
/// \sa Reference
/// \warning Making maps that can handle bool type (NodeMap<bool>)
/// needs some extra attention!
+ /// \todo Wrong documentation
template<class T>
class NodeMap : public ReadWriteMap< Node, T >
{
@@ -534,6 +535,7 @@
/// \sa Reference
/// \warning Making maps that can handle bool type (EdgeMap<bool>)
/// needs some extra attention!
+ /// \todo Wrong documentation
template<class T>
class EdgeMap : public ReadWriteMap<Edge,T>
{
Modified: hugo/trunk/lemon/concept/undir_graph.h
==============================================================================
--- hugo/trunk/lemon/concept/undir_graph.h (original)
+++ hugo/trunk/lemon/concept/undir_graph.h Tue Aug 16 18:44:57 2005
@@ -32,8 +32,8 @@
namespace lemon {
namespace concept {
- /// Skeleton class which describes an edge with direction in \ref
- /// UndirGraph "undirected graph".
+// /// Skeleton class which describes an edge with direction in \ref
+// /// UndirGraph "undirected graph".
template <typename UndirGraph>
class UndirGraphEdge : public UndirGraph::UndirEdge {
typedef typename UndirGraph::UndirEdge UndirEdge;
@@ -674,6 +674,7 @@
/// \sa Reference
/// \warning Making maps that can handle bool type (NodeMap<bool>)
/// needs some extra attention!
+ /// \todo Wrong documentation
template<class T>
class NodeMap : public ReadWriteMap< Node, T >
{
@@ -697,6 +698,7 @@
/// \sa Reference
/// \warning Making maps that can handle bool type (EdgeMap<bool>)
/// needs some extra attention!
+ /// \todo Wrong documentation
template<class T>
class EdgeMap : public ReadWriteMap<Edge,T>
{
@@ -719,6 +721,7 @@
/// \sa Reference
/// \warning Making maps that can handle bool type (UndirEdgeMap<bool>)
/// needs some extra attention!
+ /// \todo Wrong documentation
template<class T>
class UndirEdgeMap : public ReadWriteMap<UndirEdge,T>
{
@@ -790,69 +793,69 @@
/// \brief Target node of the directed edge.
Node target(Edge) const { return INVALID; }
- /// \brief First node of the graph
- ///
- /// \note This method is part of so called \ref
- /// developpers_interface "Developpers' interface", so it shouldn't
- /// be used in an end-user program.
+// /// \brief First node of the graph
+// ///
+// /// \note This method is part of so called \ref
+// /// developpers_interface "Developpers' interface", so it shouldn't
+// /// be used in an end-user program.
void first(Node&) const {}
- /// \brief Next node of the graph
- ///
- /// \note This method is part of so called \ref
- /// developpers_interface "Developpers' interface", so it shouldn't
- /// be used in an end-user program.
+// /// \brief Next node of the graph
+// ///
+// /// \note This method is part of so called \ref
+// /// developpers_interface "Developpers' interface", so it shouldn't
+// /// be used in an end-user program.
void next(Node&) const {}
- /// \brief First undirected edge of the graph
- ///
- /// \note This method is part of so called \ref
- /// developpers_interface "Developpers' interface", so it shouldn't
- /// be used in an end-user program.
+// /// \brief First undirected edge of the graph
+// ///
+// /// \note This method is part of so called \ref
+// /// developpers_interface "Developpers' interface", so it shouldn't
+// /// be used in an end-user program.
void first(UndirEdge&) const {}
- /// \brief Next undirected edge of the graph
- ///
- /// \note This method is part of so called \ref
- /// developpers_interface "Developpers' interface", so it shouldn't
- /// be used in an end-user program.
+// /// \brief Next undirected edge of the graph
+// ///
+// /// \note This method is part of so called \ref
+// /// developpers_interface "Developpers' interface", so it shouldn't
+// /// be used in an end-user program.
void next(UndirEdge&) const {}
- /// \brief First directed edge of the graph
- ///
- /// \note This method is part of so called \ref
- /// developpers_interface "Developpers' interface", so it shouldn't
- /// be used in an end-user program.
+// /// \brief First directed edge of the graph
+// ///
+// /// \note This method is part of so called \ref
+// /// developpers_interface "Developpers' interface", so it shouldn't
+// /// be used in an end-user program.
void first(Edge&) const {}
- /// \brief Next directed edge of the graph
- ///
- /// \note This method is part of so called \ref
- /// developpers_interface "Developpers' interface", so it shouldn't
- /// be used in an end-user program.
+// /// \brief Next directed edge of the graph
+// ///
+// /// \note This method is part of so called \ref
+// /// developpers_interface "Developpers' interface", so it shouldn't
+// /// be used in an end-user program.
void next(Edge&) const {}
- /// \brief First outgoing edge from a given node
- ///
- /// \note This method is part of so called \ref
- /// developpers_interface "Developpers' interface", so it shouldn't
- /// be used in an end-user program.
+// /// \brief First outgoing edge from a given node
+// ///
+// /// \note This method is part of so called \ref
+// /// developpers_interface "Developpers' interface", so it shouldn't
+// /// be used in an end-user program.
void firstOut(Edge&, Node) const {}
- /// \brief Next outgoing edge to a node
- ///
- /// \note This method is part of so called \ref
- /// developpers_interface "Developpers' interface", so it shouldn't
- /// be used in an end-user program.
+// /// \brief Next outgoing edge to a node
+// ///
+// /// \note This method is part of so called \ref
+// /// developpers_interface "Developpers' interface", so it shouldn't
+// /// be used in an end-user program.
void nextOut(Edge&) const {}
- /// \brief First incoming edge to a given node
- ///
- /// \note This method is part of so called \ref
- /// developpers_interface "Developpers' interface", so it shouldn't
- /// be used in an end-user program.
+// /// \brief First incoming edge to a given node
+// ///
+// /// \note This method is part of so called \ref
+// /// developpers_interface "Developpers' interface", so it shouldn't
+// /// be used in an end-user program.
void firstIn(Edge&, Node) const {}
- /// \brief Next incoming edge to a node
- ///
- /// \note This method is part of so called \ref
- /// developpers_interface "Developpers' interface", so it shouldn't
- /// be used in an end-user program.
+// /// \brief Next incoming edge to a node
+// ///
+// /// \note This method is part of so called \ref
+// /// developpers_interface "Developpers' interface", so it shouldn't
+// /// be used in an end-user program.
void nextIn(Edge&) const {}
Modified: hugo/trunk/lemon/utility.h
==============================================================================
--- hugo/trunk/lemon/utility.h (original)
+++ hugo/trunk/lemon/utility.h Tue Aug 16 18:44:57 2005
@@ -43,16 +43,26 @@
namespace lemon
{
- /// Basic type for defining "tags". A "YES" condition for enable_if.
+ /// Basic type for defining "tags". A "YES" condition for \c enable_if.
+ /// Basic type for defining "tags". A "YES" condition for \c enable_if.
+ ///
+ ///\sa False
+ ///
/// \todo This should go to a separate "basic_types.h" (or something)
/// file.
struct True {
+ ///\e
static const bool value = true;
};
- /// Basic type for defining "tags". A "NO" condition for enable_if.
+ /// Basic type for defining "tags". A "NO" condition for \c enable_if.
+
+ /// Basic type for defining "tags". A "NO" condition for \c enable_if.
+ ///
+ ///\sa True
struct False {
+ ///\e
static const bool value = false;
};
More information about the Lemon-commits
mailing list