COIN-OR::LEMON - Graph Library

Ticket #69: 60aca94c7cb5.patch

File 60aca94c7cb5.patch, 4.1 KB (added by Balazs Dezso, 8 years ago)

Doc fixes

  • lemon/concepts/bpgraph.h

    # HG changeset patch
    # User Balazs Dezso <deba@inf.elte.hu>
    # Date 1326319085 -3600
    # Node ID 60aca94c7cb52d5ebfc9b0632d565ee8487f6b55
    # Parent  37d179a450778255e09c55e8758b09668a10ffef
    Doc fix
    
    diff -r 37d179a45077 -r 60aca94c7cb5 lemon/concepts/bpgraph.h
    a b  
    774774
    775775      /// \brief Converts the node to red node object.
    776776      ///
    777       /// This class is converts unsafely the node to red node
     777      /// This function converts unsafely the node to red node
    778778      /// object. It should be called only if the node is from the red
    779779      /// partition or INVALID.
    780780      RedNode asRedNodeUnsafe(const Node&) const { return RedNode(); }
    781781
    782782      /// \brief Converts the node to blue node object.
    783783      ///
    784       /// This class is converts unsafely the node to blue node
     784      /// This function converts unsafely the node to blue node
    785785      /// object. It should be called only if the node is from the red
    786786      /// partition or INVALID.
    787787      BlueNode asBlueNodeUnsafe(const Node&) const { return BlueNode(); }
    788788
    789789      /// \brief Converts the node to red node object.
    790790      ///
    791       /// This class is converts safely the node to red node
     791      /// This function converts safely the node to red node
    792792      /// object. If the node is not from the red partition, then it
    793793      /// returns INVALID.
    794794      RedNode asRedNode(const Node&) const { return RedNode(); }
    795795
    796796      /// \brief Converts the node to blue node object.
    797797      ///
    798       /// This class is converts unsafely the node to blue node
     798      /// This function converts unsafely the node to blue node
    799799      /// object. If the node is not from the blue partition, then it
    800800      /// returns INVALID.
    801801      BlueNode asBlueNode(const Node&) const { return BlueNode(); }
  • lemon/concepts/graph_components.h

    diff -r 37d179a45077 -r 60aca94c7cb5 lemon/concepts/graph_components.h
    a b  
    313313      /// \brief Class to represent red nodes.
    314314      ///
    315315      /// This class represents the red nodes of the graph. The red
    316       /// nodes can be used also as normal nodes.
     316      /// nodes can also be used as normal nodes.
    317317      class RedNode : public Node {
    318318        typedef Node Parent;
    319319
     
    342342      /// \brief Class to represent blue nodes.
    343343      ///
    344344      /// This class represents the blue nodes of the graph. The blue
    345       /// nodes can be used also as normal nodes.
     345      /// nodes can also be used as normal nodes.
    346346      class BlueNode : public Node {
    347347        typedef Node Parent;
    348348
     
    397397
    398398      /// \brief Converts the node to red node object.
    399399      ///
    400       /// This class is converts unsafely the node to red node
     400      /// This function converts unsafely the node to red node
    401401      /// object. It should be called only if the node is from the red
    402402      /// partition or INVALID.
    403403      RedNode asRedNodeUnsafe(const Node&) const { return RedNode(); }
    404404
    405405      /// \brief Converts the node to blue node object.
    406406      ///
    407       /// This class is converts unsafely the node to blue node
     407      /// This function converts unsafely the node to blue node
    408408      /// object. It should be called only if the node is from the red
    409409      /// partition or INVALID.
    410410      BlueNode asBlueNodeUnsafe(const Node&) const { return BlueNode(); }
    411411
    412412      /// \brief Converts the node to red node object.
    413413      ///
    414       /// This class is converts safely the node to red node
     414      /// This function converts safely the node to red node
    415415      /// object. If the node is not from the red partition, then it
    416416      /// returns INVALID.
    417417      RedNode asRedNode(const Node&) const { return RedNode(); }
    418418
    419419      /// \brief Converts the node to blue node object.
    420420      ///
    421       /// This class is converts unsafely the node to blue node
     421      /// This function converts unsafely the node to blue node
    422422      /// object. If the node is not from the blue partition, then it
    423423      /// returns INVALID.
    424424      BlueNode asBlueNode(const Node&) const { return BlueNode(); }