Changeset 1896:92ef660710f1 in lemon-0.x for gui/kruskalbox.h

Timestamp:

01/14/06 14:42:37 (18 years ago)

Author:

Hegyi Péter

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2471

Message:

Documentation of classes realizing algorithm running.

File:

• gui/kruskalbox.h (modified) (1 diff)

gui/kruskalbox.h

@@ -12 +12 @@
 #include <libgnomecanvasmm/polygon.h>
 
+///Graphical interface to run Kruskal algorithm.
+
+///Child of \ref AlgoBox,
+///therefore the only task to do at implementation was to
+///
+///-call init function with correct parameters from correctly parametrized constructor
+///
+///-implement \ref build_box function
+///
+///-implement \ref run function
 class KruskalBox : public AlgoBox
 {
+  ///Shows result of Kruskal algorithm
   Gtk::Label resultlabel;
 
 public:
+  ///Calls \ref AlgoBox::init function to initialize class properly, automatically.
   KruskalBox(std::vector<std::string> t);
-    
+
+  ///Prepare, run and postprocess Kruskal algorithm.
+
+  ///\ref glemon works only with maps filled with double values
+  ///at the moment. While Kruskal nedds a bool map as output.
+  ///As postprocess this bool map should be transformed to
+  ///double map.
   void run();
-    
+
+  ///Builds the graphical design of the interface.
   void build_box();
 };