Changeset 3187 in orxonox.OLD for orxonox/trunk/gui/orxonox_gui_gtk.h

Timestamp:

Dec 15, 2004, 9:00:38 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk/gui: doxygen-tags… it's very much.

File:

• orxonox/trunk/gui/orxonox_gui_gtk.h (modified) (6 diffs)

orxonox/trunk/gui/orxonox_gui_gtk.h

@@ -38 +38 @@
 {
  private:
+
  public:
   ~Widget ();
@@ -111 +112 @@
 {
  private:
-  bool isOpen;
- public:
-  static Window* mainWindow;
+  bool isOpen;                //!< A bool Variable that checks if a Window is already open.
+ public:
+  static Window* mainWindow;  //!< Pointer to the First Window that was opened. By default this should be the GUI's main-Window.
   static void addWindow(Window* windowToAdd);
 
@@ -163 +164 @@
 //! A Box can contain multiple Widgets
 /**
- * A Box can Contain multiple Widgets, that are ordered either horizontally or vertically
- * I defined the standartbox to be horizontally.
- * A Box is always filled left->right (horizontally) or up->down (vertically)
- */
+   A Box can Contain multiple Widgets, that are ordered either horizontally or vertically
+   I defined the standartbox to be horizontally.
+   A Box is always filled left->right (horizontally) or up->down (vertically)
+*/
 class Box : public Packer
 {
@@ -204 +205 @@
   char* flagNameShort; //!< like flag_name but shorter
   int defaultValue; //!< A default value is good, for hiding a option if it is not needed. (hidden if value == default_value)
-  bool saveable;  //! Options can be Saved.
+  bool saveable;  //!< Options can be Saved.
 
   void setFlagName (char* flagname, int defaultvalue);
@@ -268 +269 @@
  private:
 #ifdef HAVE_GTK2
-  GtkWidget* menu;
-  GtkWidget* item;
-#endif /* HAVE_GTK2 */
-  va_list itemlist;
+  GtkWidget* menu;     //!< The menu That will hold the Options.
+  GtkWidget* item;     //!< One Item From a Menu.
+#endif /* HAVE_GTK2 */
+  va_list itemlist;    //!> The list to readin multiple Options.
   
  public:
@@ -293 +294 @@
   void init(void);
   
-  char* cValue;
+  char* cValue;   //!< The Value the Label will have.
   
   void setValue(char* newValue);