Changes in src/UIElements/Menu/Menu.hpp [56f73b:163110]

File:

• src/UIElements/Menu/Menu.hpp (modified) (1 diff)

src/UIElements/Menu/Menu.hpp

@@ -61 +61 @@
 
 protected:
-  // Unique name of the menu for identification.
+  //!> Unique name of the menu for identification.
   const std::string name;
 
-  // populater function that adds all menu items
+  /** populater function that adds all menu items.
+   *
+   */
   void populate();
+
+  /** Populater function for all Actions in this menu.
+   *
+   */
   void populateActions();
 
 private:
-  void addAction(const std::string &ActionName);
+  /** Adds an action to this menu.
+   *
+   * @param ActionName name of action
+   * @param ActionDescription of the action (e.g. for tooltips)
+   */
+  void addAction(const std::string &ActionName, const std::string &ActionDescription);
+
+  /** Adds a separator (e.g. horizontal line) to menu.
+   *
+   */
   void addSeparator();
+
+  /** Adds a submenu to this menu.
+   *
+   * @param MenuName name of submenu
+   * @param MenuPosition position in sequence of items of submenu
+   */
   void addSubmenu(const std::string &MenuName, const int MenuPosition);
+
+  /** Checks whether an item named \a token exists in this menu.
+   *
+   * @param token name of action of submenu
+   * @return true - item exists, false - item does not exist in this menu
+   */
   bool isPresent(const std::string &token);
 
+  //!> enumeration of all valid item types
   enum ItemType {ActionItem, MenuItem, SeparatorItem, NoItem};
 
-  int TopPosition;  // current position to add
-  enum ItemType LastItem;  // check whether separator followed separator
-  std::set <std::string> DuplicatesList;  // is used to check for duplicates
+  //!> current position to add
+  int TopPosition;
+  //!> check whether separator followed separator
+  enum ItemType LastItem;
+  //!> is used to check for duplicates
+  std::set <std::string> DuplicatesList;
 };