Doc fix in BpGraphs (#69)
authorBalazs Dezso <deba@inf.elte.hu>
Wed, 11 Jan 2012 22:58:05 +0100
changeset 11964441b066368c
parent 1195 8b2b9e61d8ce
child 1197 374a9519986b
Doc fix in BpGraphs (#69)
lemon/concepts/bpgraph.h
lemon/concepts/graph_components.h
     1.1 --- a/lemon/concepts/bpgraph.h	Wed Jan 11 22:43:50 2012 +0100
     1.2 +++ b/lemon/concepts/bpgraph.h	Wed Jan 11 22:58:05 2012 +0100
     1.3 @@ -774,28 +774,28 @@
     1.4  
     1.5        /// \brief Converts the node to red node object.
     1.6        ///
     1.7 -      /// This class is converts unsafely the node to red node
     1.8 +      /// This function converts unsafely the node to red node
     1.9        /// object. It should be called only if the node is from the red
    1.10        /// partition or INVALID.
    1.11        RedNode asRedNodeUnsafe(const Node&) const { return RedNode(); }
    1.12  
    1.13        /// \brief Converts the node to blue node object.
    1.14        ///
    1.15 -      /// This class is converts unsafely the node to blue node
    1.16 +      /// This function converts unsafely the node to blue node
    1.17        /// object. It should be called only if the node is from the red
    1.18        /// partition or INVALID.
    1.19        BlueNode asBlueNodeUnsafe(const Node&) const { return BlueNode(); }
    1.20  
    1.21        /// \brief Converts the node to red node object.
    1.22        ///
    1.23 -      /// This class is converts safely the node to red node
    1.24 +      /// This function converts safely the node to red node
    1.25        /// object. If the node is not from the red partition, then it
    1.26        /// returns INVALID.
    1.27        RedNode asRedNode(const Node&) const { return RedNode(); }
    1.28  
    1.29        /// \brief Converts the node to blue node object.
    1.30        ///
    1.31 -      /// This class is converts unsafely the node to blue node
    1.32 +      /// This function converts unsafely the node to blue node
    1.33        /// object. If the node is not from the blue partition, then it
    1.34        /// returns INVALID.
    1.35        BlueNode asBlueNode(const Node&) const { return BlueNode(); }
     2.1 --- a/lemon/concepts/graph_components.h	Wed Jan 11 22:43:50 2012 +0100
     2.2 +++ b/lemon/concepts/graph_components.h	Wed Jan 11 22:58:05 2012 +0100
     2.3 @@ -318,7 +318,7 @@
     2.4        /// \brief Class to represent red nodes.
     2.5        ///
     2.6        /// This class represents the red nodes of the graph. The red
     2.7 -      /// nodes can be used also as normal nodes.
     2.8 +      /// nodes can also be used as normal nodes.
     2.9        class RedNode : public Node {
    2.10          typedef Node Parent;
    2.11  
    2.12 @@ -347,7 +347,7 @@
    2.13        /// \brief Class to represent blue nodes.
    2.14        ///
    2.15        /// This class represents the blue nodes of the graph. The blue
    2.16 -      /// nodes can be used also as normal nodes.
    2.17 +      /// nodes can also be used as normal nodes.
    2.18        class BlueNode : public Node {
    2.19          typedef Node Parent;
    2.20  
    2.21 @@ -402,28 +402,28 @@
    2.22  
    2.23        /// \brief Converts the node to red node object.
    2.24        ///
    2.25 -      /// This class is converts unsafely the node to red node
    2.26 +      /// This function converts unsafely the node to red node
    2.27        /// object. It should be called only if the node is from the red
    2.28        /// partition or INVALID.
    2.29        RedNode asRedNodeUnsafe(const Node&) const { return RedNode(); }
    2.30  
    2.31        /// \brief Converts the node to blue node object.
    2.32        ///
    2.33 -      /// This class is converts unsafely the node to blue node
    2.34 +      /// This function converts unsafely the node to blue node
    2.35        /// object. It should be called only if the node is from the red
    2.36        /// partition or INVALID.
    2.37        BlueNode asBlueNodeUnsafe(const Node&) const { return BlueNode(); }
    2.38  
    2.39        /// \brief Converts the node to red node object.
    2.40        ///
    2.41 -      /// This class is converts safely the node to red node
    2.42 +      /// This function converts safely the node to red node
    2.43        /// object. If the node is not from the red partition, then it
    2.44        /// returns INVALID.
    2.45        RedNode asRedNode(const Node&) const { return RedNode(); }
    2.46  
    2.47        /// \brief Converts the node to blue node object.
    2.48        ///
    2.49 -      /// This class is converts unsafely the node to blue node
    2.50 +      /// This function converts unsafely the node to blue node
    2.51        /// object. If the node is not from the blue partition, then it
    2.52        /// returns INVALID.
    2.53        BlueNode asBlueNode(const Node&) const { return BlueNode(); }