Changeset 78b9d9 for molecuilder/src/UIElements

Timestamp:

Mar 3, 2010, 1:57:41 PM (16 years ago)

Author:

Tillmann Crueger <crueger@…>

Children:

14d898

Parents:

dc5413

Message:

Improved Doxygen documentation

Location:

molecuilder/src/UIElements

Files:

• MainWindow.hpp (modified) (1 diff)
• UIFactory.hpp (modified) (3 diffs)

molecuilder/src/UIElements/MainWindow.hpp

@@ -25 +25 @@
 };
 
+/**
+ * The type of menuPopulators
+ */
 typedef void (*MenuMaker)(Menu*,MoleculeListClass*, config*, periodentafel*);
 
+/**
+ * This contains all Functions that are used to create the menus.
+ * Needs a specific funtion for each menu. All populators will be called
+ * by the UIFactory upon creation of the main menu. Thus the actuall construction
+ * of the Menus can be kept independent of the concrete type of UI that is being
+ * built.
+ */
 struct menuPopulaters{
   MenuMaker MakeEditMoleculesMenu;

molecuilder/src/UIElements/UIFactory.hpp

@@ -17 +17 @@
 
 struct menuPopulaters;
-
+/**
+ * Abstract Factory to create any kind of User interface object needed by the programm.
+ *
+ * The factory can be created and has to be set to a certain type upon creation. It will then
+ * only create UIelements of that certain type, so that all UIElements match. This way different
+ * UIs can be handled in a concise abstract way.
+ */
 class UIFactory
 {
@@ -25 +31 @@
   virtual ~UIFactory();
 
-  // methods for creating UIElements
+  /**
+   * Produce some kind of main window, of whichever type was chosen when the factory was created
+   */
   virtual MainWindow* makeMainWindow(menuPopulaters,MoleculeListClass *, config *, periodentafel *, char *)=0;
+
+  /**
+   * Produce a User Interaction Dialog, that can query values from the User.
+   * Again the type is determined upon factory creation.
+   */
   virtual Dialog* makeDialog()=0;
 
@@ -37 +50 @@
 
 public:
+  /**
+   * create a Factory of a certain type. From that moment on only those UIElements can be produced by the factory
+   */
   static void makeUserInterface(InterfaceTypes type);
+
+  /**
+   * get the previously created factory
+   */
   static UIFactory* get();
+
+  /**
+   * Destroy the created factory.
+   *
+   * Make sure that all UIElements that were created by the factory are destroyed before calling this method.
+   */
   static void purgeInstance();
 };