Changeset da09909 for molecuilder/src/Menu/Menu.hpp

Timestamp:

Dec 16, 2009, 2:40:09 PM (16 years ago)

Author:

Tillmann Crueger <crueger@…>

Children:

38546d

Parents:

c2c893

Message:

Improved documentation for menu framework.

File:

• molecuilder/src/Menu/Menu.hpp (modified) (2 diffs)

molecuilder/src/Menu/Menu.hpp

@@ -13 +13 @@
 class MenuItem;
 
+/**
+ * Base class for all Types of menus
+ * contains basic abstract functionality to add Items, remove Items and display the menu
+ *
+ * TODO: Make sure all items are only added once.
+ */
 class Menu
 {
@@ -19 +25 @@
   virtual ~Menu();
 
+
+  /**
+   * Adding and removing should be handled by the items.
+   */
   virtual void addItem(MenuItem*)=0;
+  /**
+   * Adding and removing should be handled by the items.
+   */
   virtual void removeItem(MenuItem*)=0;
   virtual void display()=0;