Doc improvements
authoralpar
Fri, 05 Nov 2004 07:26:20 +0000
changeset 9642c0c20e90116
parent 963 5a7556e9e340
child 965 1e16b8dac159
Doc improvements
src/lemon/concept/graph_component.h
src/lemon/dimacs.h
src/lemon/graph_utils.h
src/lemon/xy.h
     1.1 --- a/src/lemon/concept/graph_component.h	Fri Nov 05 05:46:46 2004 +0000
     1.2 +++ b/src/lemon/concept/graph_component.h	Fri Nov 05 07:26:20 2004 +0000
     1.3 @@ -34,7 +34,7 @@
     1.4      /// Skeleton class for graph Node and Edge
     1.5  
     1.6      /// \note Because Node and Edge are forbidden to inherit from the same
     1.7 -    /// base class, this is a template. For Node you shoul instantiate it
     1.8 +    /// base class, this is a template. For Node you should instantiate it
     1.9      /// with character 'n' and for Edge with 'e'.
    1.10  
    1.11      template<char Ch>
     2.1 --- a/src/lemon/dimacs.h	Fri Nov 05 05:46:46 2004 +0000
     2.2 +++ b/src/lemon/dimacs.h	Fri Nov 05 07:26:20 2004 +0000
     2.3 @@ -35,7 +35,10 @@
     2.4    /// Dimacs min cost flow reader function.
     2.5  
     2.6    /// This function reads a min cost flow instance from dimacs format,
     2.7 -  /// i.e. from dimacs files having a line starting with \c p \c "min".
     2.8 +  /// i.e. from dimacs files having a line starting with
     2.9 +  /// \code
    2.10 +  /// p "min"
    2.11 +  /// \endcode
    2.12    /// At the beginning \c g is cleared by \c g.clear(). The edge
    2.13    /// capacities are written to \c capacity, \c s and \c t are set to
    2.14    /// the source and the target nodes resp. and the cost of the edges
    2.15 @@ -112,8 +115,11 @@
    2.16    /// Dimacs max flow reader function.
    2.17  
    2.18    /// This function reads a max flow instance from dimacs format,
    2.19 -  /// i.e. from dimacs files having a line starting with \c p \c
    2.20 -  /// "max".  At the beginning \c g is cleared by \c g.clear(). The
    2.21 +  /// i.e. from dimacs files having a line starting with
    2.22 +  /// \code
    2.23 +  /// p "max"
    2.24 +  /// \endcode
    2.25 +  ///At the beginning \c g is cleared by \c g.clear(). The
    2.26    /// edge capacities are written to \c capacity and \c s and \c t are
    2.27    /// set to the source and the target nodes.
    2.28    ///
    2.29 @@ -129,7 +135,10 @@
    2.30    /// Dimacs shortest path reader function.
    2.31  
    2.32    /// This function reads a shortest path instance from dimacs format,
    2.33 -  /// i.e. from dimacs files having a line starting with \c p \c "sp".
    2.34 +  /// i.e. from dimacs files having a line starting with
    2.35 +  /// \code
    2.36 +  /// p "sp"
    2.37 +  /// \endcode
    2.38    /// At the beginning \c g is cleared by \c g.clear(). The edge
    2.39    /// capacities are written to \c capacity and \c s is set to the
    2.40    /// source node.
    2.41 @@ -162,7 +171,11 @@
    2.42  
    2.43    /// This function reads a graph without any designated nodes and
    2.44    /// maps from dimacs format, i.e. from dimacs files having a line
    2.45 -  /// starting with \c p \c "mat".  At the beginning \c g is cleared
    2.46 +  /// starting with
    2.47 +  /// \code
    2.48 +  /// p "mat"
    2.49 +  /// \endcode
    2.50 +  /// At the beginning \c g is cleared
    2.51    /// by \c g.clear().
    2.52    ///
    2.53    /// \author Marton Makai
     3.1 --- a/src/lemon/graph_utils.h	Fri Nov 05 05:46:46 2004 +0000
     3.2 +++ b/src/lemon/graph_utils.h	Fri Nov 05 07:26:20 2004 +0000
     3.3 @@ -25,6 +25,9 @@
     3.4  ///\file
     3.5  ///\brief Graph utilities.
     3.6  ///
     3.7 +///\todo Please
     3.8 +///revise the documentation.
     3.9 +///
    3.10  
    3.11  
    3.12  namespace lemon {
    3.13 @@ -52,7 +55,7 @@
    3.14    ///
    3.15    /// This function counts the nodes in the graph.
    3.16    /// The complexity of the function is O(n) but for some
    3.17 -  /// graph structure it is specialized to O(1).
    3.18 +  /// graph structure it is specialized to run in O(1).
    3.19  
    3.20    template <typename Graph>
    3.21    inline int countNodes(const Graph& _g) {
    3.22 @@ -63,7 +66,7 @@
    3.23    ///
    3.24    /// This function counts the edges in the graph.
    3.25    /// The complexity of the function is O(e) but for some
    3.26 -  /// graph structure it is specialized to O(1).
    3.27 +  /// graph structure it is specialized to run in O(1).
    3.28    template <typename Graph>
    3.29    inline int countEdges(const Graph& _g) {
    3.30      return countItems<Graph, typename Graph::EdgeIt>(_g);
    3.31 @@ -73,7 +76,7 @@
    3.32    ///
    3.33    /// This function counts the symmetric edges in the graph.
    3.34    /// The complexity of the function is O(e) but for some
    3.35 -  /// graph structure it is specialized to O(1).
    3.36 +  /// graph structure it is specialized to run in O(1).
    3.37    template <typename Graph>
    3.38    inline int countSymEdges(const Graph& _g) {
    3.39      return countItems<Graph, typename Graph::SymEdgeIt>(_g);
    3.40 @@ -87,12 +90,20 @@
    3.41      }
    3.42      return num;
    3.43    }
    3.44 +  
    3.45 +  ///\e
    3.46  
    3.47 +  ///\todo Please document.
    3.48 +  ///
    3.49    template <typename Graph>
    3.50    inline int countOutEdges(const Graph& _g,  const typename Graph::Node& _n) {
    3.51      return countNodeDegree<Graph, typename Graph::OutEdgeIt>(_g, _n);
    3.52    }
    3.53  
    3.54 +  ///\e
    3.55 +
    3.56 +  ///\todo Please document.
    3.57 +  ///
    3.58    template <typename Graph>
    3.59    inline int countInEdges(const Graph& _g,  const typename Graph::Node& _n) {
    3.60      return countNodeDegree<Graph, typename Graph::InEdgeIt>(_g, _n);
     4.1 --- a/src/lemon/xy.h	Fri Nov 05 05:46:46 2004 +0000
     4.2 +++ b/src/lemon/xy.h	Fri Nov 05 07:26:20 2004 +0000
     4.3 @@ -50,6 +50,8 @@
     4.4  
     4.5      public:
     4.6  
     4.7 +      typedef T ValueType;
     4.8 +
     4.9        T x,y;     
    4.10        
    4.11        ///Default constructor: both coordinates become 0