Doc changes:
authoralpar
Tue, 16 Aug 2005 16:44:57 +0000
changeset 1630f67737f5727a
parent 1629 a245eff568a6
child 1631 e15162d8eca1
Doc changes:
- True and False got documented
- Graph "developper interface" documentation switched off
- minor fix in graph_to_eps_demo.cc
demo/graph_to_eps_demo.cc
lemon/concept/graph.h
lemon/concept/undir_graph.h
lemon/utility.h
     1.1 --- a/demo/graph_to_eps_demo.cc	Tue Aug 16 16:42:04 2005 +0000
     1.2 +++ b/demo/graph_to_eps_demo.cc	Tue Aug 16 16:44:57 2005 +0000
     1.3 @@ -24,7 +24,7 @@
     1.4  /// graphToEps(), and showing how to draw directed/undirected graphs,
     1.5  /// how to handle parallel egdes, how to change the properties (like
     1.6  /// color, shape, size, title etc.) of nodes and edges individually
     1.7 -/// using appropriate \ref maps-page "graphmapfactory".
     1.8 +/// using appropriate \ref maps-page "graph maps".
     1.9  
    1.10  #include <cmath>
    1.11  
     2.1 --- a/lemon/concept/graph.h	Tue Aug 16 16:42:04 2005 +0000
     2.2 +++ b/lemon/concept/graph.h	Tue Aug 16 16:44:57 2005 +0000
     2.3 @@ -427,53 +427,53 @@
     2.4        ///
     2.5        Node source(Edge) const { return INVALID; }
     2.6  
     2.7 -      /// Gives back the first Node in the iterating order.
     2.8 +//       /// Gives back the first Node in the iterating order.
     2.9        
    2.10 -      /// Gives back the first Node in the iterating order.
    2.11 -      ///     
    2.12 +//       /// Gives back the first Node in the iterating order.
    2.13 +//       ///     
    2.14        void first(Node&) const {}
    2.15  
    2.16 -      /// Gives back the next Node in the iterating order.
    2.17 +//       /// Gives back the next Node in the iterating order.
    2.18        
    2.19 -      /// Gives back the next Node in the iterating order.
    2.20 -      ///     
    2.21 +//       /// Gives back the next Node in the iterating order.
    2.22 +//       ///     
    2.23        void next(Node&) const {}
    2.24  
    2.25 -      /// Gives back the first Edge in the iterating order.
    2.26 +//       /// Gives back the first Edge in the iterating order.
    2.27        
    2.28 -      /// Gives back the first Edge in the iterating order.
    2.29 -      ///     
    2.30 +//       /// Gives back the first Edge in the iterating order.
    2.31 +//       ///     
    2.32        void first(Edge&) const {}
    2.33 -      /// Gives back the next Edge in the iterating order.
    2.34 +//       /// Gives back the next Edge in the iterating order.
    2.35        
    2.36 -      /// Gives back the next Edge in the iterating order.
    2.37 -      ///     
    2.38 +//       /// Gives back the next Edge in the iterating order.
    2.39 +//       ///     
    2.40        void next(Edge&) const {}
    2.41  
    2.42  
    2.43 -      /// Gives back the first of the Edges point to the given Node.
    2.44 +//       /// Gives back the first of the Edges point to the given Node.
    2.45        
    2.46 -      /// Gives back the first of the Edges point to the given Node.
    2.47 -      ///     
    2.48 +//       /// Gives back the first of the Edges point to the given Node.
    2.49 +//       ///     
    2.50        void firstIn(Edge&, const Node&) const {}
    2.51  
    2.52 -      /// Gives back the next of the Edges points to the given Node.
    2.53 +//       /// Gives back the next of the Edges points to the given Node.
    2.54  
    2.55  
    2.56 -      /// Gives back the next of the Edges points to the given Node.
    2.57 -      ///
    2.58 +//       /// Gives back the next of the Edges points to the given Node.
    2.59 +//       ///
    2.60        void nextIn(Edge&) const {}
    2.61  
    2.62 -      /// Gives back the first of the Edges start from the given Node.
    2.63 +//       /// Gives back the first of the Edges start from the given Node.
    2.64        
    2.65 -      /// Gives back the first of the Edges start from the given Node.
    2.66 -      ///     
    2.67 +//       /// Gives back the first of the Edges start from the given Node.
    2.68 +//       ///     
    2.69        void firstOut(Edge&, const Node&) const {}
    2.70  
    2.71 -      /// Gives back the next of the Edges start from the given Node.
    2.72 +//       /// Gives back the next of the Edges start from the given Node.
    2.73        
    2.74 -      /// Gives back the next of the Edges start from the given Node.
    2.75 -      ///     
    2.76 +//       /// Gives back the next of the Edges start from the given Node.
    2.77 +//       ///     
    2.78        void nextOut(Edge&) const {}
    2.79  
    2.80        /// \brief The base node of the iterator.
    2.81 @@ -511,6 +511,7 @@
    2.82        /// \sa Reference
    2.83        /// \warning Making maps that can handle bool type (NodeMap<bool>)
    2.84        /// needs some extra attention!
    2.85 +      /// \todo Wrong documentation
    2.86        template<class T> 
    2.87        class NodeMap : public ReadWriteMap< Node, T >
    2.88        {
    2.89 @@ -534,6 +535,7 @@
    2.90        /// \sa Reference
    2.91        /// \warning Making maps that can handle bool type (EdgeMap<bool>)
    2.92        /// needs some extra attention!
    2.93 +      /// \todo Wrong documentation
    2.94        template<class T> 
    2.95        class EdgeMap : public ReadWriteMap<Edge,T>
    2.96        {
     3.1 --- a/lemon/concept/undir_graph.h	Tue Aug 16 16:42:04 2005 +0000
     3.2 +++ b/lemon/concept/undir_graph.h	Tue Aug 16 16:44:57 2005 +0000
     3.3 @@ -32,8 +32,8 @@
     3.4  namespace lemon {
     3.5    namespace concept {
     3.6  
     3.7 -    /// Skeleton class which describes an edge with direction in \ref
     3.8 -    /// UndirGraph "undirected graph".
     3.9 +//     /// Skeleton class which describes an edge with direction in \ref
    3.10 +//     /// UndirGraph "undirected graph".
    3.11      template <typename UndirGraph>
    3.12      class UndirGraphEdge : public UndirGraph::UndirEdge {
    3.13        typedef typename UndirGraph::UndirEdge UndirEdge;
    3.14 @@ -674,6 +674,7 @@
    3.15        /// \sa Reference
    3.16        /// \warning Making maps that can handle bool type (NodeMap<bool>)
    3.17        /// needs some extra attention!
    3.18 +      /// \todo Wrong documentation
    3.19        template<class T> 
    3.20        class NodeMap : public ReadWriteMap< Node, T >
    3.21        {
    3.22 @@ -697,6 +698,7 @@
    3.23        /// \sa Reference
    3.24        /// \warning Making maps that can handle bool type (EdgeMap<bool>)
    3.25        /// needs some extra attention!
    3.26 +      /// \todo Wrong documentation
    3.27        template<class T> 
    3.28        class EdgeMap : public ReadWriteMap<Edge,T>
    3.29        {
    3.30 @@ -719,6 +721,7 @@
    3.31        /// \sa Reference
    3.32        /// \warning Making maps that can handle bool type (UndirEdgeMap<bool>)
    3.33        /// needs some extra attention!
    3.34 +      /// \todo Wrong documentation
    3.35        template<class T> 
    3.36        class UndirEdgeMap : public ReadWriteMap<UndirEdge,T>
    3.37        {
    3.38 @@ -790,69 +793,69 @@
    3.39        /// \brief Target node of the directed edge.
    3.40        Node target(Edge) const { return INVALID; }
    3.41  
    3.42 -      /// \brief First node of the graph
    3.43 -      ///
    3.44 -      /// \note This method is part of so called \ref
    3.45 -      /// developpers_interface "Developpers' interface", so it shouldn't
    3.46 -      /// be used in an end-user program.
    3.47 +//       /// \brief First node of the graph
    3.48 +//       ///
    3.49 +//       /// \note This method is part of so called \ref
    3.50 +//       /// developpers_interface "Developpers' interface", so it shouldn't
    3.51 +//       /// be used in an end-user program.
    3.52        void first(Node&) const {}
    3.53 -      /// \brief Next node of the graph
    3.54 -      ///
    3.55 -      /// \note This method is part of so called \ref
    3.56 -      /// developpers_interface "Developpers' interface", so it shouldn't
    3.57 -      /// be used in an end-user program.
    3.58 +//       /// \brief Next node of the graph
    3.59 +//       ///
    3.60 +//       /// \note This method is part of so called \ref
    3.61 +//       /// developpers_interface "Developpers' interface", so it shouldn't
    3.62 +//       /// be used in an end-user program.
    3.63        void next(Node&) const {}
    3.64  
    3.65 -      /// \brief First undirected edge of the graph
    3.66 -      ///
    3.67 -      /// \note This method is part of so called \ref
    3.68 -      /// developpers_interface "Developpers' interface", so it shouldn't
    3.69 -      /// be used in an end-user program.
    3.70 +//       /// \brief First undirected edge of the graph
    3.71 +//       ///
    3.72 +//       /// \note This method is part of so called \ref
    3.73 +//       /// developpers_interface "Developpers' interface", so it shouldn't
    3.74 +//       /// be used in an end-user program.
    3.75        void first(UndirEdge&) const {}
    3.76 -      /// \brief Next undirected edge of the graph
    3.77 -      ///
    3.78 -      /// \note This method is part of so called \ref
    3.79 -      /// developpers_interface "Developpers' interface", so it shouldn't
    3.80 -      /// be used in an end-user program.
    3.81 +//       /// \brief Next undirected edge of the graph
    3.82 +//       ///
    3.83 +//       /// \note This method is part of so called \ref
    3.84 +//       /// developpers_interface "Developpers' interface", so it shouldn't
    3.85 +//       /// be used in an end-user program.
    3.86        void next(UndirEdge&) const {}
    3.87  
    3.88 -      /// \brief First directed edge of the graph
    3.89 -      ///
    3.90 -      /// \note This method is part of so called \ref
    3.91 -      /// developpers_interface "Developpers' interface", so it shouldn't
    3.92 -      /// be used in an end-user program.
    3.93 +//       /// \brief First directed edge of the graph
    3.94 +//       ///
    3.95 +//       /// \note This method is part of so called \ref
    3.96 +//       /// developpers_interface "Developpers' interface", so it shouldn't
    3.97 +//       /// be used in an end-user program.
    3.98        void first(Edge&) const {}
    3.99 -      /// \brief Next directed edge of the graph
   3.100 -      ///
   3.101 -      /// \note This method is part of so called \ref
   3.102 -      /// developpers_interface "Developpers' interface", so it shouldn't
   3.103 -      /// be used in an end-user program.
   3.104 +//       /// \brief Next directed edge of the graph
   3.105 +//       ///
   3.106 +//       /// \note This method is part of so called \ref
   3.107 +//       /// developpers_interface "Developpers' interface", so it shouldn't
   3.108 +//       /// be used in an end-user program.
   3.109        void next(Edge&) const {}
   3.110  
   3.111 -      /// \brief First outgoing edge from a given node
   3.112 -      ///
   3.113 -      /// \note This method is part of so called \ref
   3.114 -      /// developpers_interface "Developpers' interface", so it shouldn't
   3.115 -      /// be used in an end-user program.
   3.116 +//       /// \brief First outgoing edge from a given node
   3.117 +//       ///
   3.118 +//       /// \note This method is part of so called \ref
   3.119 +//       /// developpers_interface "Developpers' interface", so it shouldn't
   3.120 +//       /// be used in an end-user program.
   3.121        void firstOut(Edge&, Node) const {}
   3.122 -      /// \brief Next outgoing edge to a node
   3.123 -      ///
   3.124 -      /// \note This method is part of so called \ref
   3.125 -      /// developpers_interface "Developpers' interface", so it shouldn't
   3.126 -      /// be used in an end-user program.
   3.127 +//       /// \brief Next outgoing edge to a node
   3.128 +//       ///
   3.129 +//       /// \note This method is part of so called \ref
   3.130 +//       /// developpers_interface "Developpers' interface", so it shouldn't
   3.131 +//       /// be used in an end-user program.
   3.132        void nextOut(Edge&) const {}
   3.133  
   3.134 -      /// \brief First incoming edge to a given node
   3.135 -      ///
   3.136 -      /// \note This method is part of so called \ref
   3.137 -      /// developpers_interface "Developpers' interface", so it shouldn't
   3.138 -      /// be used in an end-user program.
   3.139 +//       /// \brief First incoming edge to a given node
   3.140 +//       ///
   3.141 +//       /// \note This method is part of so called \ref
   3.142 +//       /// developpers_interface "Developpers' interface", so it shouldn't
   3.143 +//       /// be used in an end-user program.
   3.144        void firstIn(Edge&, Node) const {}
   3.145 -      /// \brief Next incoming edge to a node
   3.146 -      ///
   3.147 -      /// \note This method is part of so called \ref
   3.148 -      /// developpers_interface "Developpers' interface", so it shouldn't
   3.149 -      /// be used in an end-user program.
   3.150 +//       /// \brief Next incoming edge to a node
   3.151 +//       ///
   3.152 +//       /// \note This method is part of so called \ref
   3.153 +//       /// developpers_interface "Developpers' interface", so it shouldn't
   3.154 +//       /// be used in an end-user program.
   3.155        void nextIn(Edge&) const {}
   3.156  
   3.157  
     4.1 --- a/lemon/utility.h	Tue Aug 16 16:42:04 2005 +0000
     4.2 +++ b/lemon/utility.h	Tue Aug 16 16:44:57 2005 +0000
     4.3 @@ -43,16 +43,26 @@
     4.4  namespace lemon
     4.5  {
     4.6  
     4.7 -  /// Basic type for defining "tags". A "YES" condition for enable_if.
     4.8 +  /// Basic type for defining "tags". A "YES" condition for \c enable_if.
     4.9  
    4.10 +  /// Basic type for defining "tags". A "YES" condition for \c enable_if.
    4.11 +  ///
    4.12 +  ///\sa False
    4.13 +  ///
    4.14    /// \todo This should go to a separate "basic_types.h" (or something)
    4.15    /// file.
    4.16    struct True {
    4.17 +    ///\e
    4.18      static const bool value = true;
    4.19    };
    4.20  
    4.21 -  /// Basic type for defining "tags". A "NO" condition for enable_if.
    4.22 +  /// Basic type for defining "tags". A "NO" condition for \c enable_if.
    4.23 +
    4.24 +  /// Basic type for defining "tags". A "NO" condition for \c enable_if.
    4.25 +  ///
    4.26 +  ///\sa True
    4.27    struct False {
    4.28 +    ///\e
    4.29      static const bool value = false;
    4.30    };
    4.31