demo/descriptor_map_demo.cc
changeset 2081 94a7deb46c07
parent 1956 a055123339d5
child 2207 75a29ac69c19
     1.1 --- a/demo/descriptor_map_demo.cc	Fri May 12 09:57:03 2006 +0000
     1.2 +++ b/demo/descriptor_map_demo.cc	Fri May 12 15:29:42 2006 +0000
     1.3 @@ -16,6 +16,16 @@
     1.4   *
     1.5   */
     1.6  
     1.7 +/// \ingroup demos
     1.8 +/// \file
     1.9 +/// \brief Using descriptor map and own special map types.
    1.10 +///
    1.11 +/// This demo shows how can be used the DescriptorMap class
    1.12 +/// which helps to use unique label for each node or edge.
    1.13 +/// And it gives an example how easy is creating own map types.
    1.14 +///
    1.15 +/// \include descriptor_map_demo.cc
    1.16 +
    1.17  #include <lemon/list_graph.h>
    1.18  #include <lemon/graph_utils.h>
    1.19  #include <lemon/graph_writer.h>
    1.20 @@ -30,12 +40,13 @@
    1.21  
    1.22  using namespace lemon;
    1.23  
    1.24 -// Special map type
    1.25 -// It gives back a position for each node. The position of the nodes 
    1.26 +// Special xy<double> map type 
    1.27 +//
    1.28 +// It gives back a position for each node. The position of the nodes
    1.29  // are on the circle with the given center and radius.
    1.30  //
    1.31 -// Because we use the descriptor map it will hold the proprty described above
    1.32 -// even if a node added or deleted. 
    1.33 +// Because we use the descriptor map it will hold the proprty
    1.34 +// described above even if a node added or deleted.
    1.35  template <typename Graph>
    1.36  class CircleMap {
    1.37  public: