Index: lemon/kruskal.h =================================================================== --- lemon/kruskal.h (revision 167) +++ lemon/kruskal.h (revision 194) @@ -33,7 +33,7 @@ ///\ingroup spantree ///\file -///\brief Kruskal's algorithm to compute a minimum cost tree +///\brief Kruskal's algorithm to compute a minimum cost spanning tree /// -///Kruskal's algorithm to compute a minimum cost tree. +///Kruskal's algorithm to compute a minimum cost spanning tree. /// @@ -252,7 +252,9 @@ /// \ingroup spantree /// - /// \brief Kruskal's algorithm to find a minimum cost tree of a graph. - /// - /// This function runs Kruskal's algorithm to find a minimum cost tree. + /// \brief Kruskal algorithm to find a minimum cost spanning tree of + /// a graph. + /// + /// This function runs Kruskal's algorithm to find a minimum cost + /// spanning tree. /// Due to some C++ hacking, it accepts various input and output types. /// @@ -263,22 +265,23 @@ /// undirected by disregarding the direction of the arcs. /// - /// \param in This object is used to describe the arc costs. It can be one - /// of the following choices. + /// \param in This object is used to describe the arc/edge costs. + /// It can be one of the following choices. /// - An STL compatible 'Forward Container' with - /// std::pair or - /// std::pair as its value_type, where - /// \c X is the type of the costs. The pairs indicates the arcs + /// std::pair or + /// std::pair as its value_type, where + /// \c X is the type of the costs. The pairs indicates the arcs/edges /// along with the assigned cost. They must be in a /// cost-ascending order. - /// - Any readable Arc map. The values of the map indicate the arc costs. - /// - /// \retval out Here we also have a choise. - /// - It can be a writable \c bool arc map. After running the - /// algorithm this will contain the found minimum cost spanning - /// tree: the value of an arc will be set to \c true if it belongs + /// - Any readable arc/edge map. The values of the map indicate the + /// arc/edge costs. + /// + /// \retval out Here we also have a choice. + /// - It can be a writable \c bool arc/edge map. After running the + /// algorithm it will contain the found minimum cost spanning + /// tree: the value of an arc/edge will be set to \c true if it belongs /// to the tree, otherwise it will be set to \c false. The value of - /// each arc will be set exactly once. + /// each arc/edge will be set exactly once. /// - It can also be an iteraror of an STL Container with - /// GR::Edge or GR::Arc as its + /// GR::Arc or GR::Edge as its /// value_type. The algorithm copies the elements of the /// found tree into this sequence. For example, if we know that the @@ -291,11 +294,12 @@ /// Or if we don't know in advance the size of the tree, we can /// write this. - ///\code std::vector tree; + ///\code + /// std::vector tree; /// kruskal(g,cost,std::back_inserter(tree)); ///\endcode /// - /// \return The total cost of the found tree. - /// - /// \warning If kruskal runs on an be consistent of using the same + /// \return The total cost of the found spanning tree. + /// + /// \warning If Kruskal runs on an be consistent of using the same /// Arc type for input and output. ///