Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib/gui


Ignore:
Timestamp:
Jul 12, 2005, 12:33:16 AM (19 years ago)
Author:
bensch
Message:

orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit :)

Location:
orxonox/trunk/src/lib/gui
Files:
15 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/src/lib/gui/gui.cc

    r4746 r4836  
    4848
    4949/**
    50    \brief Initializes the Gui
     50 * Initializes the Gui
    5151*/
    5252Gui::Gui(int argc, char *argv[])
    … …  
    121121
    122122/**
    123    \brief starts the OrxonoxGUI
     123 * starts the OrxonoxGUI
    124124*/
    125125void Gui::startGui()
    … …  
    138138
    139139/**
    140    \brief a bool that knows if orxonox should be started
     140 * a bool that knows if orxonox should be started
    141141*/
    142142bool Gui::startOrxonox = false;
    143143
    144144/**
    145    \brief Destructor.
     145 * Destructor.
    146146*/
    147147Gui::~Gui()

  • orxonox/trunk/src/lib/gui/gui.h

    r4746 r4836  
    33 \brief Creation of the Gui
    44
    5  \todo way to start gui without GTK (textmode) AND IMPROOVE
    6  \todo curl interface to Download cool stuff
     5 @todo way to start gui without GTK (textmode) AND IMPROOVE
     6 @todo curl interface to Download cool stuff
    77
    8  \todo widgets save themselves
    9  \todo good way to step through all the Widgets
    10  \todo label -> protected : getlabel function
     8 @todo widgets save themselves
     9 @todo good way to step through all the Widgets
     10 @todo label -> protected : getlabel function
    1111*/
    1212

  • orxonox/trunk/src/lib/gui/gui_audio.cc

    r4746 r4836  
    2929
    3030/**
    31    \brief Creates an Audio-Frame
     31 * Creates an Audio-Frame
    3232*/
    3333GuiAudio::GuiAudio()
    … …  
    7272
    7373/**
    74     \brief Destructs the Audio-Stuff
     74  * Destructs the Audio-Stuff
    7575*/
    7676GuiAudio::~GuiAudio()

  • orxonox/trunk/src/lib/gui/gui_banner.cc

    r4746 r4836  
    3232
    3333/**
    34    \brief Creates a new BannerEventBox and its content.
     34 * Creates a new BannerEventBox and its content.
    3535*/
    3636GuiBanner::GuiBanner()
    … …  
    7575    logoBox->fill(logoImage);
    7676
    77     //! \todo add the names of all the guys working on orxonox
     77    //! @todo add the names of all the guys working on orxonox
    7878    orxIsLabel = new Label("           " PACKAGE_NAME " is:\n" ORXONOX_STAFF);
    7979    logoBox->fill(orxIsLabel);
    … …  
    9090
    9191/**
    92    \brief Destructs it.
     92 * Destructs it.
    9393*/
    9494GuiBanner::~GuiBanner()

  • orxonox/trunk/src/lib/gui/gui_element.cc

    r4427 r4836  
    2424
    2525/**
    26    \brief standard constructor
    27    \todo this constructor is not jet implemented - do it
     26 * standard constructor
     27   @todo this constructor is not jet implemented - do it
    2828*/
    2929GuiElement::GuiElement ()
    … …  
    3434
    3535/**
    36    \brief standard deconstructor
     36 * standard deconstructor
    3737
    3838*/
    … …  
    4343
    4444/**
    45    \brief Every GuiElement should set this, or it could result in a SegFault.
     45 * Every GuiElement should set this, or it could result in a SegFault.
    4646*/
    4747void GuiElement::setMainWidget(Widget* widget)

  • orxonox/trunk/src/lib/gui/gui_element.h

    r4746 r4836  
    11/*!
    22    \file gui_element.h
    3     \brief Definition of ...
     3  * Definition of ...
    44
    55*/
    … …  
    1717  virtual ~GuiElement();
    1818 
    19   /** \returns the main Widget of this GuiElement. */
     19  /** @returns the main Widget of this GuiElement. */
    2020  Widget* getWidget() {return this->mainWidget;}
    2121 protected:

  • orxonox/trunk/src/lib/gui/gui_exec.cc

    r4830 r4836  
    3939
    4040/**
    41     \brief Creates the Exec-Frame
     41  * Creates the Exec-Frame
    4242*/
    4343GuiExec::GuiExec()
    … …  
    5656    {
    5757      Button* start;               //!< The start Button of orxonox.
    58       Menu* verboseMode;           //!< A Menu for setting the verbose-Mode. \todo setting up a verbose-class.
     58      Menu* verboseMode;           //!< A Menu for setting the verbose-Mode. @todo setting up a verbose-class.
    5959      CheckButton* alwaysShow;     //!< A CheckButton, for if orxonox should start with or without gui.
    6060      Button* quit;                //!< A Button to quit the Gui without starting orxonox.
    … …  
    131131
    132132/**
    133    \brief Destructs the Execution-stuff
     133 * Destructs the Execution-stuff
    134134*/
    135135GuiExec::~GuiExec()
    … …  
    144144
    145145/**
    146    \brief sets the Directory of the configuration files
    147    \param confDir the Directory for the configuration files
     146 * sets the Directory of the configuration files
     147 * @param confDir the Directory for the configuration files
    148148*/
    149149void GuiExec::setConfDir(const char* confDir)
    … …  
    161161
    162162/**
    163    \brief Sets the location of the configuration File.
    164    \param fileName the location of the configFile
     163 * Sets the location of the configuration File.
     164 * @param fileName the location of the configFile
    165165
    166166   The name will be parsed from ~/ to /home/[username] on unix and c:/Documents and Settings/username/Settings/ on Windows
    … …  
    176176
    177177/**
    178    \returns The name of the Configuration-File
     178 * @returns The name of the Configuration-File
    179179*/
    180180const char* GuiExec::getConfigFile() const
    … …  
    184184
    185185/**
    186    \brief checks if a option should be saved.
    187    \return 1 if it should 0 if not/
     186 * checks if a option should be saved.
     187 * @return 1 if it should 0 if not/
    188188*/
    189189int GuiExec::shouldsave()
    … …  
    193193
    194194/**
    195     \brief Saves the configuration-file to the Disk.\n
    196     \param widget from which Widget on should be saved.
     195  * Saves the configuration-file to the Disk.\n
     196  * @param widget from which Widget on should be saved.
    197197
    198198    this Function only opens and closes the file, in between GuiExec::writeFileText(Widget* widget) will execute the real writing process.
    … …  
    207207
    208208/**
    209    \brief Actually writes into the configuration file to the disk.
    210    \param widget from which Widget on should be saved.
    211    \param depth initially "0", and grows higher, while new Groups are bundeled.
     209 * Actually writes into the configuration file to the disk.
     210 * @param widget from which Widget on should be saved.
     211 * @param depth initially "0", and grows higher, while new Groups are bundeled.
    212212*/
    213213void GuiExec::writeFileText(Widget* widget, int depth)
    … …  
    258258
    259259/**
    260    \brief Reads in Configuration Data.
    261    \param widget from which Widget on should be saved.
     260 * Reads in Configuration Data.
     261 * @param widget from which Widget on should be saved.
    262262*/
    263263void GuiExec::readFromFile(Widget* widget)
    … …  
    307307
    308308/**
    309    \brief Maps Confugurations to the Options.
    310    \param widget which widget downwards
    311    \param varInfo Information about the Variable to read
     309 * Maps Confugurations to the Options.
     310 * @param widget which widget downwards
     311 * @param varInfo Information about the Variable to read
    312312*/
    313313void GuiExec::readFileText(Widget* widget, void* varInfo)
    … …  
    323323
    324324/**
    325    \brief Locates a Group.
    326    \param widget The Widget from where to search from
    327    \param groupName The GroupName for which to search.
    328    \param depth The Depth of the search seen from the first widget we searched from.
    329    \returns The Widget that holds the Group, or the NULL if the Group wasn't found.
    330 
    331    \todo do this in gui-gtk.
     325 * Locates a Group.
     326 * @param widget The Widget from where to search from
     327 * @param groupName The GroupName for which to search.
     328 * @param depth The Depth of the search seen from the first widget we searched from.
     329 * @returns The Widget that holds the Group, or the NULL if the Group wasn't found.
     330
     331   @todo do this in gui-gtk.
    332332*/
    333333Widget* GuiExec::locateGroup(Widget* widget, char* groupName, int depth)
    … …  
    365365
    366366/**
    367    \brief Starts ORXONOX.(not really implemented yet, but the function is there.\n
    368    \param widget the widget that executed the start command
    369    \param data additional data
     367 * Starts ORXONOX.(not really implemented yet, but the function is there.\n
     368 * @param widget the widget that executed the start command
     369 * @param data additional data
    370370
    371371   This is a Signal and can be executed through Widget::signal_connect
    … …  
    390390
    391391/**
    392    \brief Starts ORXONOX.(not really implemented yet, but the function is there.\n
    393    \param widget the widget that executed the start command
    394    \param data additional data
     392 * Starts ORXONOX.(not really implemented yet, but the function is there.\n
     393 * @param widget the widget that executed the start command
     394 * @param data additional data
    395395
    396396   This is a Signal and can be executed through Widget::signal_connect

  • orxonox/trunk/src/lib/gui/gui_flags.cc

    r4746 r4836  
    2727
    2828/**
    29    \brief Creates the Flags-Frame
     29 * Creates the Flags-Frame
    3030*/
    3131GuiFlags::GuiFlags()
    … …  
    4646
    4747/**
    48    \brief Destructs the Flags-stuff
     48 * Destructs the Flags-stuff
    4949*/
    5050GuiFlags::~GuiFlags()
    … …  
    5454
    5555/**
    56    \brief Sets the Flags from widget downwards.
    57    \param widget the Widget from which on to scan for deeper Options and their settings.
     56 * Sets the Flags from widget downwards.
     57 * @param widget the Widget from which on to scan for deeper Options and their settings.
    5858*/
    5959void GuiFlags::setTextFromFlags(Widget* widget)
    … …  
    7070
    7171/**
    72     \brief this actually sets the flagtext, and appends it to flagText
    73     \param widget like GuiFlags::setTextFromFlags(widget)
    74     \param flagInfo Information aboout the Flag that should be updated.
     72  * this actually sets the flagtext, and appends it to flagText
     73  * @param widget like GuiFlags::setTextFromFlags(widget)
     74  * @param flagInfo Information aboout the Flag that should be updated.
    7575*/
    7676void GuiFlags::flagsText(Widget* widget, void* flagInfo)

  • orxonox/trunk/src/lib/gui/gui_flags.h

    r4746 r4836  
    1717  Frame* flagsFrame;          //!< The Frame that holds the flagsDisplay.
    1818  Box* flagsBox;              //!< The Box that holds the flagsDisplay.
    19   CheckButton* shortFlags;    //!< CheckButton to change the display of short and long flags \todo show long if long not availible...
     19  CheckButton* shortFlags;    //!< CheckButton to change the display of short and long flags @todo show long if long not availible...
    2020  Label* flagsLabel;          //!< The Label of the Flags
    2121

  • orxonox/trunk/src/lib/gui/gui_gtk.cc

    r4746 r4836  
    4242
    4343/**
    44    \brief Initializes the Guis GTK-stuff.
    45    \param argc the argument count.
    46    \param argv The Argument strings.
     44 * Initializes the Guis GTK-stuff.
     45 * @param argc the argument count.
     46 * @param argv The Argument strings.
    4747*/
    4848bool initGUI(int argc, char *argv[])
    … …  
    6464
    6565/**
    66    \brief enters the GUI's main-loop
     66 * enters the GUI's main-loop
    6767*/
    6868bool mainloopGUI()
    … …  
    128128     
    129129      // here follows the rest.... this will be nasty.
    130       //! \todo finish it.
    131       //! \todo memory leek at save(); and save is a BAD word, use saveString instead, or something like it.
     130      //! @todo finish it.
     131      //! @todo memory leek at save(); and save is a BAD word, use saveString instead, or something like it.
    132132    }
    133133#endif /* HAVE_GTK2 */
    … …  
    144144////////////
    145145/**
    146    \brief constructs a Widget
     146 * constructs a Widget
    147147*/
    148148Widget::Widget()
    … …  
    153153
    154154/**
    155    \brief deletes any given Widget
     155 * deletes any given Widget
    156156   This is still pretty crappy.
    157157*/
    … …  
    170170  this->next = NULL;
    171171
    172   //!  \todo not hiding widget, deleting.
     172  //!  @todo not hiding widget, deleting.
    173173  //  this->hide();
    174174  // gtk_destroy_widget(this->widget);
    … …  
    176176
    177177/**
    178    \brief sets a new Title to a Widget
    179    \param title The new Title to set to the Widget
     178 * sets a new Title to a Widget
     179 * @param title The new Title to set to the Widget
    180180*/
    181181void Widget::setTitle(const char* title)
    … …  
    188188
    189189/**
    190    \brief makes the widget visible.
     190 * makes the widget visible.
    191191*/
    192192void Widget::show()
    … …  
    198198
    199199/**
    200    \brief hides the widget.
     200 * hides the widget.
    201201*/
    202202void Widget::hide()
    … …  
    208208
    209209/**
    210    \brief Sets the resolution of a specific widget to the given size.
    211    \param width the width of the widget to set.
    212    \param height the height of the widget to set.
     210 * Sets the resolution of a specific widget to the given size.
     211 * @param width the width of the widget to set.
     212 * @param height the height of the widget to set.
    213213*/
    214214void Widget::setSize(int width, int height)
    … …  
    220220
    221221/**
    222    \brief searches through widgets for a Name.
     222 * searches through widgets for a Name.
    223223*/
    224224Widget* Widget::findWidgetByName(char* name, unsigned int depth)
    … …  
    242242
    243243/**
    244    \brief Moves through all the Widgets downwards from this and executes the function on them.
    245    \param function must be of type void and takes a Widget* as an Input.
    246    \param depth the current depth. if > 0 then the next Widget will also be walked through.
     244 * Moves through all the Widgets downwards from this and executes the function on them.
     245 * @param function must be of type void and takes a Widget* as an Input.
     246 * @param depth the current depth. if > 0 then the next Widget will also be walked through.
    247247*/
    248248void Widget::walkThrough(void(*function)(Widget*), unsigned int depth)
    … …  
    259259
    260260/**
    261    \brief Moves through all the Widgets downwards from this and executes the function on them.
    262    \param function must be of type void and takes a Widget* as an Input.
    263    \param data Additional Data you want to pass to the function.
    264    \param depth the current depth. if > 0 then the next Widget will also be walked through.
     261 * Moves through all the Widgets downwards from this and executes the function on them.
     262 * @param function must be of type void and takes a Widget* as an Input.
     263 * @param data Additional Data you want to pass to the function.
     264 * @param depth the current depth. if > 0 then the next Widget will also be walked through.
    265265*/
    266266void Widget::walkThrough(void(*function)(Widget*, void*), void* data, unsigned int depth)
    … …  
    276276
    277277/**
    278     \brief This is for listing the options of "widget"
    279     \param widget specifies the widget that should be listed
     278  * This is for listing the options of "widget"
     279  * @param widget specifies the widget that should be listed
    280280*/
    281281void Widget::listOptionsAndGroups(Widget* widget)
    … …  
    290290
    291291/**
    292     \brief This is for listing the options of "widget"
    293     \param widget specifies the widget that should be listed
     292  * This is for listing the options of "widget"
     293  * @param widget specifies the widget that should be listed
    294294*/
    295295void Widget::listOptions(Widget* widget)
    … …  
    300300
    301301/**
    302     \brief This is for listing the options of "widget"
    303     \param widget specifies the widget that should be listed
    304     \param data A Counter, that always knows how many Options have been found yet.
     302  * This is for listing the options of "widget"
     303  * @param widget specifies the widget that should be listed
     304  * @param data A Counter, that always knows how many Options have been found yet.
    305305*/
    306306void Widget::listOptions(Widget* widget, void* data)
    … …  
    318318
    319319/**
    320     \brief This is for listing the options of "widget"
    321     \param widget specifies the widget that should be listed
    322     \param data A Counter, that always knows how many Options have been found yet.
     320  * This is for listing the options of "widget"
     321  * @param widget specifies the widget that should be listed
     322  * @param data A Counter, that always knows how many Options have been found yet.
    323323*/
    324324void Widget::printHelp(Widget* widget)
    … …  
    358358
    359359/**
    360     \brief Finds an Option by a given number(the n'th option found away from this Widget)
    361     \param number The Count of options to wait(by reference)
    362     \param depth The depth of the sarch. if 0 it will not search next pointer
     360  * Finds an Option by a given number(the n'th option found away from this Widget)
     361  * @param number The Count of options to wait(by reference)
     362  * @param depth The depth of the sarch. if 0 it will not search next pointer
    363363   
    364     \todo should return Option* would be much sexier.
     364    @todo should return Option* would be much sexier.
    365365*/
    366366Widget* Widget::findOptionByNumber(int* number, unsigned int depth)
    … …  
    387387
    388388/**
    389     \brief This is for listing the groups of "widget"
    390     \param widget specifies the widget that should be listed
     389  * This is for listing the groups of "widget"
     390  * @param widget specifies the widget that should be listed
    391391*/
    392392void Widget::listGroups(Widget* widget)
    … …  
    397397
    398398/**
    399     \brief This is for listing the Groups of "widget". It also displays the n'th number found.
    400     \param widget specifies the widget that should be listed
    401     \param data the Counter, that will show the number(this function will raise it by one if a Group is fount.
     399  * This is for listing the Groups of "widget". It also displays the n'th number found.
     400  * @param widget specifies the widget that should be listed
     401  * @param data the Counter, that will show the number(this function will raise it by one if a Group is fount.
    402402*/
    403403void Widget::listGroups(Widget* widget, void* data)
    … …  
    409409
    410410/**
    411     \brief Finds a Group by a given number(the n'th Group found away from this Widget)
    412     \param number The Count of options to wait(by reference)
    413     \param depth The depth of the sarch. if 0 it will not search next pointer
     411  * Finds a Group by a given number(the n'th Group found away from this Widget)
     412  * @param number The Count of options to wait(by reference)
     413  * @param depth The depth of the sarch. if 0 it will not search next pointer
    414414*/
    415415Widget* Widget::findGroupByNumber(int* number, unsigned int depth)
    … …  
    436436
    437437/**
    438     \brief This is for setting the option of "widget"
    439     \param widget specifies the widget that should be set.
     438  * This is for setting the option of "widget"
     439  * @param widget specifies the widget that should be set.
    440440*/
    441441void Widget::setOptions(Widget* widget)
    … …  
    446446
    447447/**
    448    \brief redraws all the Widgets down from widget
    449    \param widget The topmost Widget
    450    \param data ...
     448 * redraws all the Widgets down from widget
     449 * @param widget The topmost Widget
     450 * @param data ...
    451451*/
    452452void Widget::redrawOptions(Widget* widget)
    … …  
    457457
    458458/**
    459    \brief Walks through all the Flags given at startuptime.
     459 * Walks through all the Flags given at startuptime.
    460460*/
    461461void Widget::flagCheck(Widget* widget, void* flagName)
    … …  
    510510#ifdef HAVE_GTK2
    511511/**
    512     \brief Connect any signal to any given Sub-widget
     512  * Connect any signal to any given Sub-widget
    513513*/
    514514gulong Widget::connectSignal(char* event, gint(*signal)(GtkWidget*, GdkEvent*, void *))
    … …  
    518518
    519519/**
    520    \brief Connect a signal with additionally passing the whole Object
     520 * Connect a signal with additionally passing the whole Object
    521521*/
    522522gulong Widget::connectSignal(char* event, gint(*signal)( GtkWidget*, Widget *))
    … …  
    526526
    527527/**
    528    \brief Connect a signal with additionally passing a whole external Object
     528 * Connect a signal with additionally passing a whole external Object
    529529*/
    530530gulong Widget::connectSignal(char* event, void* extObj, gint(*signal)(GtkWidget*, GdkEvent*, void *))
    … …  
    534534
    535535/**
    536    \brief Connect a signal with additionally passing a whole external Object
     536 * Connect a signal with additionally passing a whole external Object
    537537*/
    538538gulong Widget::connectSignal(char* event, void* extObj, gint(*signal)(GtkWidget*, void *))
    … …  
    542542
    543543/**
    544    \brief Connect a signal with additionally passing a whole external Object
     544 * Connect a signal with additionally passing a whole external Object
    545545*/
    546546gulong Widget::connectSignal(char* event, void* extObj, gint(*signal)(GtkWidget*, GdkEventKey*, void *))
    … …  
    555555
    556556/**
    557    \brief Signal that does absolutely nothing
    558    \param widget The widget that initiated the Signal
    559    \param event The event-type.
    560    \param nothing nothin.
     557 * Signal that does absolutely nothing
     558 * @param widget The widget that initiated the Signal
     559 * @param event The event-type.
     560 * @param nothing nothin.
    561561*/
    562562gint Widget::doNothingSignal(GtkWidget *widget, GdkEvent* event, void* nothing)
    … …  
    569569/////////////
    570570/**
    571    \brief Constructs a Packer
     571 * Constructs a Packer
    572572*/
    573573Packer::Packer()
    … …  
    578578
    579579/**
    580    \brief Destroys a Packer.
     580 * Destroys a Packer.
    581581*/
    582582Packer::~Packer()
    … …  
    592592
    593593/**
    594    \brief Sets the group name under which all the lower widgets of this will be saved.
    595    \param name The name of the group.
     594 * Sets the group name under which all the lower widgets of this will be saved.
     595 * @param name The name of the group.
    596596*/
    597597void Packer::setGroupName(const char* name)
    … …  
    607607////////////////
    608608/**
    609    \brief Initializes a Container.
     609 * Initializes a Container.
    610610
    611611   sets the Container-Specific defaults.
    … …  
    617617
    618618/**
    619    \brief Destroys a Container.
     619 * Destroys a Container.
    620620*/
    621621Container::~Container()
    … …  
    625625
    626626/**
    627    \briefFills a Container with lowerWidget.
    628    \param lowerWidget the Widget that should be filled into the Container.
     627 * Fills a Container with lowerWidget.
     628 * @param lowerWidget the Widget that should be filled into the Container.
    629629
    630630   It does this by filling up the down pointer only if down points to NULL.
    … …  
    645645
    646646/**
    647    \param borderwidth sets the Width of the border
     647 * @param borderwidth sets the Width of the border
    648648*/
    649649void Container::setBorderWidth(int borderwidth)
    … …  
    661661
    662662/**
    663    \brief The main Window of Th Gui
     663 * The main Window of Th Gui
    664664*/
    665665Window* Window::mainWindow = NULL;     
    666666
    667667/**
    668    \brief Creating a Window with a name
    669    \param windowName the name the window should get.
     668 * Creating a Window with a name
     669 * @param windowName the name the window should get.
    670670*/
    671671Window::Window(const char* windowName)
    … …  
    692692
    693693/**
    694    \brief Destructs a Window.
     694 * Destructs a Window.
    695695*/
    696696Window::~Window()
    … …  
    700700
    701701/**
    702    \brief Adds a new Window Windows to the List of Windows.
    703    \param windowToAdd The Windows that should be added to the List
    704    \todo this instead of windowToAdd(possibly)
     702 * Adds a new Window Windows to the List of Windows.
     703 * @param windowToAdd The Windows that should be added to the List
     704   @todo this instead of windowToAdd(possibly)
    705705*/
    706706void Window::addWindow(Window* windowToAdd)
    … …  
    723723
    724724/**
    725    \brief Shows all Widgets that are included within this->widget.
     725 * Shows all Widgets that are included within this->widget.
    726726*/
    727727void Window::showall()
    … …  
    736736
    737737/**
    738    \brief Set The Window-title to title
    739    \param title title the Window should get.
     738 * Set The Window-title to title
     739 * @param title title the Window should get.
    740740*/
    741741void Window::setTitle(const char* title)
    … …  
    751751
    752752/**
    753    \brief opens up a Window and fixes the Focus to it
     753 * opens up a Window and fixes the Focus to it
    754754*/
    755755void Window::open()
    … …  
    766766
    767767/**
    768    \brief closes up a Window and removes the Focus from it
     768 * closes up a Window and removes the Focus from it
    769769*/
    770770void Window::close()
    … …  
    781781
    782782/**
    783    \brief opens up a window(not topmost Window).
     783 * opens up a window(not topmost Window).
    784784   this is the Signal that does it. !!SIGNALS ARE STATIC!!
    785    \param widget the widget that did it.
    786    \param event the event that did it.
    787    \param window the Window that should be opened
     785 * @param widget the widget that did it.
     786 * @param event the event that did it.
     787 * @param window the Window that should be opened
    788788*/
    789789#ifdef HAVE_GTK2
    … …  
    797797
    798798/**
    799    \brief closes a window(not topmost Window).
     799 * closes a window(not topmost Window).
    800800   this is the Signal that does it. !!SIGNALS ARE STATIC!!
    801    \param widget the widget that did it!
    802    \param event the event that did it!
    803    \param window the Window that should be closed
     801 * @param widget the widget that did it!
     802 * @param event the event that did it!
     803 * @param window the Window that should be closed
    804804*/
    805805#ifdef HAVE_GTK2
    … …  
    816816///////////
    817817/**
    818    \brief Creates a new Frame with name title
     818 * Creates a new Frame with name title
    819819*/
    820820Frame::Frame(const char* frameName)
    … …  
    829829
    830830/**
    831    \brief destrcucts a Frame
     831 * destrcucts a Frame
    832832*/
    833833Frame::~Frame()
    … …  
    837837
    838838/**
    839    \brief Sets the Frames name to title
    840    \param title The title the Frame should get.
     839 * Sets the Frames name to title
     840 * @param title The title the Frame should get.
    841841*/
    842842void Frame::setTitle(const char* title)
    … …  
    855855//////////////
    856856/**
    857    \brief Creates a new EventBox with name title
    858    \param eventBoxName title the Eventbox should get(only data-structure-internal)
     857 * Creates a new EventBox with name title
     858 * @param eventBoxName title the Eventbox should get(only data-structure-internal)
    859859*/
    860860EventBox::EventBox(const char* eventBoxName)
    … …  
    870870
    871871/**
    872    \brief destructs an EventBox.
     872 * destructs an EventBox.
    873873*/
    874874EventBox::~EventBox()
    … …  
    881881/////////
    882882/**
    883    \brief Creates a new Box of type boxtype
    884    \param boxtype if 'v' the Box will be vertically, if 'h' the Box will be horizontally
     883 * Creates a new Box of type boxtype
     884 * @param boxtype if 'v' the Box will be vertically, if 'h' the Box will be horizontally
    885885*/
    886886Box::Box(char boxtype)
    … …  
    897897
    898898/**
    899    \brief destructs a Box.
     899 * destructs a Box.
    900900*/
    901901Box::~Box()
    … …  
    905905
    906906/**
    907     \brief Fills a box with a given Widget.
    908     \param lowerWidget the next Widget that should be appendet to this Box
     907  * Fills a box with a given Widget.
     908  * @param lowerWidget the next Widget that should be appendet to this Box
    909909
    910910    It does this by apending the first one to its down-pointer and all its following ones to the preceding next-pointer. The last one will receive a NULL pointer as Next
    … …  
    931931////////////
    932932/**
    933    \brief Initializes a new Option.
     933 * Initializes a new Option.
    934934   sets all Option-Specific-Values to their defaults.
    935935*/
    … …  
    948948
    949949/**
    950    \brief Destroys an Option.
     950 * Destroys an Option.
    951951*/
    952952Option::~Option()
    … …  
    964964
    965965/**
    966    \param defaultValue new defaultValue for this option
     966 * @param defaultValue new defaultValue for this option
    967967*/
    968968void Option::setDefaultValue(int defaultValue)
    … …  
    972972
    973973/**
    974    \brief This sets The FlagName of an Option and defines its default Values
     974 * This sets The FlagName of an Option and defines its default Values
    975975   !! Options will be saved if flagname is different from NULL !!
    976    \param flagname the Name that will be displayed in the output
    977    \param defaultvalue the default Value for this Option(see definition of defaultvalue
     976 * @param flagname the Name that will be displayed in the output
     977 * @param defaultvalue the default Value for this Option(see definition of defaultvalue
    978978*/
    979979void Option::setFlagName(const char* flagname, int defaultvalue)
    … …  
    996996
    997997/**
    998     \brief see Option::setFlagName(char* flagname, int defaultvalue)
    999     \param flagname the Name that will be displayed in the output
    1000     \param defaultvalue the default Value for this Option(see definition of defaultvalue
    1001     \param flagnameshort a short flagname to be displayed in the output
     998  * see Option::setFlagName(char* flagname, int defaultvalue)
     999  * @param flagname the Name that will be displayed in the output
     1000  * @param defaultvalue the default Value for this Option(see definition of defaultvalue
     1001  * @param flagnameshort a short flagname to be displayed in the output
    10021002*/
    10031003void Option::setFlagName(const char* flagname, const char* flagnameshort,  int defaultvalue)
    … …  
    10371037
    10381038/**
    1039    \brief Sets the saveable-state of the option.
    1040    \param isSaveable the saveable-state to set.
     1039 * Sets the saveable-state of the option.
     1040 * @param isSaveable the saveable-state to set.
    10411041*/
    10421042void Option::saveability(bool isSaveable)
    … …  
    10461046
    10471047/**
    1048    \brief saves an Option
    1049    \returns the String that should be saved. (this string __should__ be deleted)
     1048 * saves an Option
     1049 * @returns the String that should be saved. (this string __should__ be deleted)
    10501050
    10511051   this is a default Option save
    … …  
    10591059
    10601060/**
    1061    \brief loads an Option from of its loadString
    1062    \param loadString the string from which to load the data from
     1061 * loads an Option from of its loadString
     1062 * @param loadString the string from which to load the data from
    10631063*/
    10641064void Option::load(char* loadString)
    … …  
    10701070
    10711071/**
    1072    \returns The saveable-state.
     1072 * @returns The saveable-state.
    10731073*/
    10741074bool Option::isSaveable()
    … …  
    10791079#ifdef HAVE_GTK2
    10801080/**
    1081     \brief Signal OptionChange writes the Value from the Option to its Object-Database.
    1082     \param widget The widget(Option) that has a changed Value
    1083     \param option the Option-Object that should receive the change.
     1081  * Signal OptionChange writes the Value from the Option to its Object-Database.
     1082  * @param widget The widget(Option) that has a changed Value
     1083  * @param option the Option-Object that should receive the change.
    10841084*/
    10851085gint Option::OptionChange(GtkWidget *widget, Widget* option)
    … …  
    10961096////////////
    10971097/**
    1098    \brief Creates a new Button with a buttonname
    1099    \param buttonName sets the Name of the Button
     1098 * Creates a new Button with a buttonname
     1099 * @param buttonName sets the Name of the Button
    11001100*/
    11011101Button::Button(const char* buttonName)
    … …  
    11121112
    11131113/**
    1114    \brief destructs a Button.
     1114 * destructs a Button.
    11151115*/
    11161116Button::~Button()
    … …  
    11201120
    11211121/**
    1122    \brief Sets a new name to the Button
    1123    \param title The name the Button should get
     1122 * Sets a new name to the Button
     1123 * @param title The name the Button should get
    11241124*/
    11251125void Button::setTitle(const char *title)
    … …  
    11351135
    11361136/**
    1137    \brief redraws the Button
    1138    \todo not implemented yet
     1137 * redraws the Button
     1138   @todo not implemented yet
    11391139*/
    11401140void Button::redraw()
    … …  
    11431143
    11441144/**
    1145    \brief Button can not be changed, optionChange is empty)
    1146 
    1147    \todo Actions for non-GTK-mode
     1145 * Button can not be changed, optionChange is empty)
     1146
     1147   @todo Actions for non-GTK-mode
    11481148*/
    11491149void Button::changeOption()
    … …  
    11561156/////////////////
    11571157/**
    1158    \brief Creates a new CheckButton with an ame
    1159    \param buttonName The name the CheckButton should display.
     1158 * Creates a new CheckButton with an ame
     1159 * @param buttonName The name the CheckButton should display.
    11601160*/
    11611161CheckButton::CheckButton(const char* buttonName)
    … …  
    11761176
    11771177/**
    1178    \brief destructs a CheckButton.
     1178 * destructs a CheckButton.
    11791179*/
    11801180CheckButton::~CheckButton()
    … …  
    11871187
    11881188/**
    1189    \brief Sets a new Title to a CheckButton
    1190    \param title The new Name the CheckButton should display.
     1189 * Sets a new Title to a CheckButton
     1190 * @param title The new Name the CheckButton should display.
    11911191*/
    11921192void CheckButton::setTitle(const char* title)
    … …  
    12021202
    12031203/**
    1204    \returns the Active state of the checkButton
     1204 * @returns the Active state of the checkButton
    12051205*/
    12061206bool CheckButton::isActive()
    … …  
    12121212
    12131213/**
    1214    \brief Changed the Option, call this Function
     1214 * Changed the Option, call this Function
    12151215*/
    12161216void CheckButton::changeOption()
    … …  
    12311231
    12321232/**
    1233    \brief Redraws the CheckButton(if option has changed).
     1233 * Redraws the CheckButton(if option has changed).
    12341234   Example: if new settings are loaded the Button must be redrawn for the GUI to display that Change
    12351235*/
    … …  
    12451245////////////
    12461246/**
    1247    \brief Creates a new Slider
    1248    \param slidername The data-structure-name of the slider.
    1249    \param start The minimal Value of the slider.
    1250    \param end The maximal Value of the slider.
     1247 * Creates a new Slider
     1248 * @param slidername The data-structure-name of the slider.
     1249 * @param start The minimal Value of the slider.
     1250 * @param end The maximal Value of the slider.
    12511251*/
    12521252Slider::Slider(const char* slidername, float start, float end)
    … …  
    12681268
    12691269/**
    1270    \brief destructs a Slider.
     1270 * destructs a Slider.
    12711271*/
    12721272Slider::~Slider()
    … …  
    12761276
    12771277/**
    1278    \brief sets the exactness of the widget
    1279    \param exactness count of digits after the dot
     1278 * sets the exactness of the widget
     1279 * @param exactness count of digits after the dot
    12801280*/
    12811281void Slider::setExactness(int exactness)
    … …  
    12881288
    12891289/**
    1290    \brief Setting a new value to the Slider.
     1290 * Setting a new value to the Slider.
    12911291   Maybe you also require a Slider::redraw() for this to display
    12921292*/
    … …  
    12971297
    12981298/**
    1299    \brief Redraws the widget
     1299 * Redraws the widget
    13001300   Example: see void CheckButton::redraw()
    13011301*/
    … …  
    13081308
    13091309/**
    1310    \brief Changed the Option, call this Function
     1310 * Changed the Option, call this Function
    13111311*/
    13121312void Slider::changeOption()
    … …  
    13461346//////////
    13471347/**
    1348    \brief constructs a new Menu, without adding any items to it.
    1349    \param menuName the Name the Menu gets.
     1348 * constructs a new Menu, without adding any items to it.
     1349 * @param menuName the Name the Menu gets.
    13501350*/
    13511351Menu::Menu(const char* menuName)
    … …  
    13561356
    13571357/**
    1358     \brief Creates a Menu-Item-list out of multiple input.
     1358  * Creates a Menu-Item-list out of multiple input.
    13591359    !! Consider, that the last input argument has to be "lastItem" for this to work!!
    1360     \param menuname The Database-Name of this Menu
    1361     \param ... items to be added to this Menu. !! Consider, that the last input argument has to be "lastItem" for this to work!!
     1360  * @param menuname The Database-Name of this Menu
     1361  * @param ... items to be added to this Menu. !! Consider, that the last input argument has to be "lastItem" for this to work!!
    13621362*/
    13631363Menu::Menu(char* menuname, ...)
    … …  
    13781378
    13791379/**
    1380    \brief destructs a Menu.
     1380 * destructs a Menu.
    13811381*/
    13821382Menu::~Menu()
    … …  
    13871387    {
    13881388      delete []this->currItem->name;
    1389       //! \todo destroy menu
     1389      //! @todo destroy menu
    13901390      /*
    13911391        #ifdef HAVE_GTK2
    … …  
    13991399
    14001400/**
    1401    \brief Initializes a new Menu with no items
     1401 * Initializes a new Menu with no items
    14021402*/
    14031403void Menu::init()
    … …  
    14151415
    14161416/**
    1417    \brief saves the Label of the Menu
    1418    \returns the name of the selected Menu-Item
     1417 * saves the Label of the Menu
     1418 * @returns the name of the selected Menu-Item
    14191419*/
    14201420char* Menu::save()
    … …  
    14371437
    14381438/**
    1439    \brief loads a Menu from of its loadString
    1440    \param loadString the string from which to load the data from
     1439 * loads a Menu from of its loadString
     1440 * @param loadString the string from which to load the data from
    14411441*/
    14421442void Menu::load(char* loadString)
    … …  
    14621462
    14631463/**
    1464    \brief appends a new Item to the Menu-List.
    1465    \param itemName the itemName to be appendet.
     1464 * appends a new Item to the Menu-List.
     1465 * @param itemName the itemName to be appendet.
    14661466*/
    14671467void Menu::addItem(char* itemName)
    … …  
    14901490
    14911491/**
    1492    \brief Redraws the widget
     1492 * Redraws the widget
    14931493   Example: see void CheckButton::redraw()
    14941494*/
    … …  
    15011501
    15021502/**
    1503    \brief Changed the Option, call this Function
     1503 * Changed the Option, call this Function
    15041504*/
    15051505void Menu::changeOption()
    … …  
    15201520
    15211521/**
    1522    \brief Creates a new OptionLabel with a LabelName and a Value.
    1523    \param label The name of the OptionLabel.
    1524    \param value The Value of the OptionLabel(what will be displayed).
     1522 * Creates a new OptionLabel with a LabelName and a Value.
     1523 * @param label The name of the OptionLabel.
     1524 * @param value The Value of the OptionLabel(what will be displayed).
    15251525*/
    15261526OptionLabel::OptionLabel(const char* label, const char* value)
    … …  
    15381538
    15391539/**
    1540    \brief destructs an OptionLabel.
     1540 * destructs an OptionLabel.
    15411541*/
    15421542OptionLabel::~OptionLabel()
    … …  
    15481548
    15491549/**
    1550    \brief Updates the value of an OptionLabel
    1551    \param newValue The new Name that should be displayed.
     1550 * Updates the value of an OptionLabel
     1551 * @param newValue The new Name that should be displayed.
    15521552*/
    15531553void OptionLabel::setValue(const char* newValue)
    … …  
    15621562
    15631563/**
    1564    \brief Redraws an OptionLabel(not implemented yet, but it works).
     1564 * Redraws an OptionLabel(not implemented yet, but it works).
    15651565*/
    15661566void OptionLabel::redraw()
    … …  
    15721572
    15731573/**
    1574    \brief Changed the Option, call this Function
     1574 * Changed the Option, call this Function
    15751575*/
    15761576void OptionLabel::changeOption()
    … …  
    15891589
    15901590/**
    1591    \brief creates the Optionlabel save-string
    1592    \returns the String to save.
     1591 * creates the Optionlabel save-string
     1592 * @returns the String to save.
    15931593*/
    15941594char* OptionLabel::save()
    … …  
    15981598
    15991599/**
    1600    \brief loads an Option from of its loadString
    1601    \param loadString the string from which to load the data from
     1600 * loads an Option from of its loadString
     1601 * @param loadString the string from which to load the data from
    16021602*/
    16031603void OptionLabel::load(char* loadString)
    … …  
    16111611///////////
    16121612/**
    1613    \brief Creates a new Label with a Text.
    1614    \param text The text to be displayed.
     1613 * Creates a new Label with a Text.
     1614 * @param text The text to be displayed.
    16151615*/
    16161616Label:: Label(const char* text)
    … …  
    16281628
    16291629/**
    1630    \brief destructs a Label.
     1630 * destructs a Label.
    16311631*/
    16321632Label::~Label()
    … …  
    16361636
    16371637/**
    1638    \brief Sets a new Text to a Label.
    1639    \param text The text to be inserted into the Label.
     1638 * Sets a new Text to a Label.
     1639 * @param text The text to be inserted into the Label.
    16401640*/
    16411641void Label::setTitle(const char* text)
    … …  
    16511651
    16521652/**
    1653    \brief ereases the Text of a Label
     1653 * ereases the Text of a Label
    16541654*/
    16551655void Label::ereaseText()
    … …  
    16591659
    16601660/**
    1661     \brief appends some Text to a Label
    1662     \param textToAppend The text that will be appended to this Label
     1661  * appends some Text to a Label
     1662  * @param textToAppend The text that will be appended to this Label
    16631663*/
    16641664void Label::appendText(char* textToAppend)
    … …  
    16811681
    16821682/**
    1683     \brief Appends some integer to the Label
    1684     \param intToAppend The Int that will be added.
     1683  * Appends some integer to the Label
     1684  * @param intToAppend The Int that will be added.
    16851685   
    16861686    it does this by just converting the int into a char* and send it to appendText
    … …  
    16951695
    16961696/**
    1697    \brief get the Text of a Label
    1698    \return The Text the Label holds.
     1697 * get the Text of a Label
     1698 * @return The Text the Label holds.
    16991699*/
    17001700const char* Label::getText()
    … …  
    17071707//////////////////
    17081708/**
    1709    \brief Creates a new ProgressBar.
    1710    \param label The name you want to get the ProgressBar.
     1709 * Creates a new ProgressBar.
     1710 * @param label The name you want to get the ProgressBar.
    17111711*/
    17121712ProgressBar::ProgressBar(const char* label)
    … …  
    17261726
    17271727/**
    1728    \brief destructs a ProgressBar
     1728 * destructs a ProgressBar
    17291729*/
    17301730ProgressBar::~ProgressBar()
    … …  
    17341734
    17351735/**
    1736    \brief Sets the Total size of the Bar.(ex. The maximum one can download)
     1736 * Sets the Total size of the Bar.(ex. The maximum one can download)
    17371737*/
    17381738void ProgressBar::setTotalSize(double totalSize)
    … …  
    17421742
    17431743/**
    1744    \brief Sets the progress maximum is this->totalSize
     1744 * Sets the progress maximum is this->totalSize
    17451745*/
    17461746void ProgressBar::setProgress(double progress)
    … …  
    17601760
    17611761/**
    1762     \brief returns the Progress Status
     1762  * returns the Progress Status
    17631763*/
    17641764double ProgressBar::getProgress()
    … …  
    17711771///////////
    17721772/**
    1773    \brief Creates a new Image
    1774    \param imageName the location of the Image on the Hard Disc
     1773 * Creates a new Image
     1774 * @param imageName the location of the Image on the Hard Disc
    17751775*/
    17761776Image::Image(const char* imageName)
    … …  
    17841784
    17851785/**
    1786    \brief Creates a new Image
    1787    \param imageData data to the PixBuff
     1786 * Creates a new Image
     1787 * @param imageData data to the PixBuff
    17881788*/
    17891789Image::Image(char** imageData)
    … …  
    17981798
    17991799/**
    1800    \brief destructs an Image.
     1800 * destructs an Image.
    18011801*/
    18021802Image::~Image()
    … …  
    18061806
    18071807/**
    1808     \brief Initializes a new Image
    1809     \param name the name to set to the Image
     1808  * Initializes a new Image
     1809  * @param name the name to set to the Image
    18101810*/
    18111811void Image::init(const char* name)
    … …  
    18241824/////////////////
    18251825/**
    1826    \brief Creates a new FileDialog
    1827    \param fileDialogName a Name for the Dialog
     1826 * Creates a new FileDialog
     1827 * @param fileDialogName a Name for the Dialog
    18281828*/
    18291829FileDialog::FileDialog(const char* fileDialogName)
    … …  
    18591859
    18601860/**
    1861    \brief destructs a FileDialog
     1861 * destructs a FileDialog
    18621862*/
    18631863FileDialog::~FileDialog()
    … …  
    19011901
    19021902/**
    1903    \brief disables the File Operator Buttons
     1903 * disables the File Operator Buttons
    19041904*/
    19051905void FileDialog::disableFileOpts()
    … …  
    19111911
    19121912/**
    1913    \brief The ok-button has been pressed
     1913 * The ok-button has been pressed
    19141914*/
    19151915void FileDialog::okEvent()

  • orxonox/trunk/src/lib/gui/gui_gtk.h

    r4746 r4836  
    122122
    123123  void setGroupName(const char* name);
    124   /** \returns the GroupName if existent NULL otherwise */
     124  /** @returns the GroupName if existent NULL otherwise */
    125125  inline const char* getGroupName() const {return this->groupName;}
    126126
    … …  
    364364  virtual void changeOption();
    365365
    366   char* cValue;                          //!< The Value the Label will have. \todo make private
     366  char* cValue;                          //!< The Value the Label will have. @todo make private
    367367};
    368368

  • orxonox/trunk/src/lib/gui/gui_keys.cc

    r4746 r4836  
    2929
    3030/**
    31    \brief Creates an Keyboard-Frame
     31 * Creates an Keyboard-Frame
    3232*/
    3333GuiKeys::GuiKeys()
    … …  
    7777
    7878/**
    79    \brief Destructs the Keys-stuff
     79 * Destructs the Keys-stuff
    8080*/
    8181GuiKeys::~GuiKeys()
    … …  
    9393////////////
    9494/**
    95    \brief Creates new inputs for a player
    96    \param player the name of the Player
     95 * Creates new inputs for a player
     96 * @param player the name of the Player
    9797*/
    9898PlayerKeys::PlayerKeys(char* player)
    … …  
    147147
    148148/**
    149    \returns the OpenButton of a Player
     149 * @returns the OpenButton of a Player
    150150*/
    151151Button* PlayerKeys::getOpenButton()
    … …  
    158158//////////////////
    159159/**
    160    \brief Creates new inputs for a misc
    161    \param player the name of the Misc
     160 * Creates new inputs for a misc
     161 * @param player the name of the Misc
    162162*/
    163163MiscKeys::MiscKeys()
    … …  
    212212
    213213/**
    214    \returns the OpenButton of a Misc
     214 * @returns the OpenButton of a Misc
    215215*/
    216216Button* MiscKeys::getOpenButton()
    … …  
    221221
    222222/**
    223    \brief adds a new Key.
    224    \param key the number of the Key
    225    \param name The name of the new Key.
    226    \returns A widget that has the Key-Box
     223 * adds a new Key.
     224 * @param key the number of the Key
     225 * @param name The name of the new Key.
     226 * @returns A widget that has the Key-Box
    227227*/
    228228Widget* addKey(const char* name, const char* defaultVal)
    … …  
    256256 
    257257/**
    258    \brief Function which gets keystrokes
    259    \param w the widget that released the Function.
    260    \param event The event that happened.
    261    \param Widget the Widget which will be applied.
    262    \returns Nothing
     258 * Function which gets keystrokes
     259 * @param w the widget that released the Function.
     260 * @param event The event that happened.
     261 * @param Widget the Widget which will be applied.
     262 * @returns Nothing
    263263*/
    264264gint key_cb(GtkWidget* w, GdkEventKey* event, void* inputKey)

  • orxonox/trunk/src/lib/gui/gui_update.cc

    r4774 r4836  
    3333
    3434/**
    35    \brief Creates an Update-Frame
     35 * Creates an Update-Frame
    3636*/
    3737GuiUpdate::GuiUpdate()
    … …  
    9898
    9999/**
    100    \brief Destructs the Update-stuff
     100 * Destructs the Update-stuff
    101101*/
    102102GuiUpdate::~GuiUpdate()
    … …  
    106106
    107107/**
    108    \brief checks if the Folder containing selected File is data.oxd, and if so sets it.
    109    \param
     108 * checks if the Folder containing selected File is data.oxd, and if so sets it.
     109 * @param
    110110*/
    111111bool GuiUpdate::checkDataDir(const char* fileName, void* object)
    … …  
    126126
    127127/**
    128     \brief Look what info we can get from this system
     128  * Look what info we can get from this system
    129129*/
    130130bool GuiUpdate::getSystemInfo()
    … …  
    167167
    168168/**
    169    \brief Creates a window, and all it contains for the Data-update.
     169 * Creates a window, and all it contains for the Data-update.
    170170*/
    171171void GuiUpdate::updateDataWindowCreate()
    … …  
    206206
    207207/**
    208    \returns A Pointer to the Button of the UpdaterDataWindow
     208 * @returns A Pointer to the Button of the UpdaterDataWindow
    209209*/
    210210Button* GuiUpdate::updateDataWindowGetButton()
    … …  
    214214
    215215/**
    216    \brief Creates a window, and all it contains for the Source-update.
     216 * Creates a window, and all it contains for the Source-update.
    217217*/
    218218void GuiUpdate::updateSourceWindowCreate()
    … …  
    245245
    246246/**
    247    \returns A Pointer to the Button of the UpdaterSourceWindow
     247 * @returns A Pointer to the Button of the UpdaterSourceWindow
    248248*/
    249249Button* GuiUpdate::updateSourceWindowGetButton()
    … …  
    255255#ifdef HAVE_GTK2
    256256/**
    257    \brief updates the Data of orxonox.
    258    \param w The widget, that executed this Function.
    259    \param event The event that trigered this Function.
    260    \param button The Button, that triggered this event.
     257 * updates the Data of orxonox.
     258 * @param w The widget, that executed this Function.
     259 * @param event The event that trigered this Function.
     260 * @param button The Button, that triggered this event.
    261261*/
    262262gint GuiUpdate::updateDataFunc(GtkWidget* w, GdkEventKey* event, void* info)
    … …  
    272272
    273273/**
    274    \brief updates the source of orxonox.
    275    \param w The widget, that executed this Function.
    276    \param event The event that trigered this Function.
    277    \param button The Button, that triggered this event.
     274 * updates the source of orxonox.
     275 * @param w The widget, that executed this Function.
     276 * @param event The event that trigered this Function.
     277 * @param button The Button, that triggered this event.
    278278*/
    279279gint GuiUpdate::updateSourceFunc(GtkWidget* w, GdkEventKey* event, void* bar)
    … …  
    286286
    287287/**
    288    \brief The Function Curl calls to write out the File.
    289    \param ptr A Pointer to the date to write.
    290    \param size The size in bytes of one nmemb to write.
    291    \param nmemb The Count of size to write.
    292    \param stream Filehandler to write to.
     288 * The Function Curl calls to write out the File.
     289 * @param ptr A Pointer to the date to write.
     290 * @param size The size in bytes of one nmemb to write.
     291 * @param nmemb The Count of size to write.
     292 * @param stream Filehandler to write to.
    293293*/
    294294size_t GuiUpdate::curlWriteFunc(void* ptr, size_t size, size_t nmemb, FILE* stream)
    … …  
    298298
    299299/**
    300    \brief The Function Curl calls to write out the File.
    301    \param ptr A Pointer to the date to write to.
    302    \param size The size in bytes of one nmemb to write.
    303    \param nmemb The Count of size to write.
    304    \param stream Filehandler to get data from.
     300 * The Function Curl calls to write out the File.
     301 * @param ptr A Pointer to the date to write to.
     302 * @param size The size in bytes of one nmemb to write.
     303 * @param nmemb The Count of size to write.
     304 * @param stream Filehandler to get data from.
    305305*/
    306306size_t GuiUpdate::curlReadFunc(void* ptr, size_t size, size_t nmemb, FILE* stream)
    … …  
    311311
    312312/**
    313    \brief An update Function for the GUI, to show the progress.
    314    \param Bar th ProgressBar to update
    315    \param totalSize The total size of the download in bytes.
    316    \param progress The current Progress of the download in bytes.
    317    \param upTotal not needed
    318    \param upProgress not needed
     313 * An update Function for the GUI, to show the progress.
     314 * @param Bar th ProgressBar to update
     315 * @param totalSize The total size of the download in bytes.
     316 * @param progress The current Progress of the download in bytes.
     317 * @param upTotal not needed
     318 * @param upProgress not needed
    319319*/
    320320int GuiUpdate::curlProgressFunc(ProgressBar* bar, double totalSize, double progress, double upTotal, double upProgress)
    … …  
    329329
    330330/**
    331    \brief The Curl handle for only one CURL(static).
     331 * The Curl handle for only one CURL(static).
    332332*/
    333333CURL* GuiUpdate::curlHandle = NULL;
    … …  
    340340
    341341/**
    342    \brief Initializes a Download without displaying it.
    343    \param fileInfo the FileInfo.
     342 * Initializes a Download without displaying it.
     343 * @param fileInfo the FileInfo.
    344344
    345345   !! BE AWARE THIS WILL NOT BE THREADED. !!
    … …  
    359359  char* fileOnNet = new char [strlen(info->webRoot)+strlen(info->fileName)+2];
    360360  strcpy(fileOnNet, info->webRoot);
    361   if(fileOnNet[strlen(fileOnNet)] != '/') //!< \todo windows-shit
     361  if(fileOnNet[strlen(fileOnNet)] != '/') //!< @todo windows-shit
    362362    strcat(fileOnNet, "/");
    363363  strcat(fileOnNet, info->fileName);
    364364  char* fileOnDisk = new char [strlen(info->localRoot)+strlen(info->fileName)+2];
    365365  strcpy(fileOnDisk, info->localRoot);
    366   if(fileOnDisk[strlen(fileOnDisk)] != '/') //!< \todo windows-shit
     366  if(fileOnDisk[strlen(fileOnDisk)] != '/') //!< @todo windows-shit
    367367    strcat(fileOnDisk, "/");
    368368  strcat(fileOnDisk, info->fileName);
    … …  
    387387
    388388/**
    389    \brief Initializes a Download with some style.
    390    \param fileInfo the FileInfo.
    391    \todo release thread-lock.
     389 * Initializes a Download with some style.
     390 * @param fileInfo the FileInfo.
     391   @todo release thread-lock.
    392392
    393393   Downloading with a Button that gets a different Name while downloading, and a Bar, that gets to be updated. More to be followed
    … …  
    447447
    448448/**
    449    \brief The downloading process(either threaded or not).
    450    \param fileInfo the FileInfo.
    451 
    452    \todo Threads get locked, if the cancel button is pressed in to small intervals.
     449 * The downloading process(either threaded or not).
     450 * @param fileInfo the FileInfo.
     451
     452   @todo Threads get locked, if the cancel button is pressed in to small intervals.
    453453*/
    454454void* GuiUpdate::downloadThread(void* fileInfo)
    … …  
    459459
    460460/**
    461    \brief Finishes a downloading process.
    462    \param fileInfo the FileInfo.
     461 * Finishes a downloading process.
     462 * @param fileInfo the FileInfo.
    463463*/
    464464void* GuiUpdate::downloadThreadFinished(void* fileInfo)
    … …  
    485485#ifdef HAVE_GTK2
    486486/**
    487    \brief canceles a downloading session.
    488    \param w The widget, that executed this Function.
    489    \param event The event that trigered this Function.
    490    \param bar The Bar, that triggered this event.
    491 
    492    \todo canceling a session in non-threaded mode.
     487 * canceles a downloading session.
     488 * @param w The widget, that executed this Function.
     489 * @param event The event that trigered this Function.
     490 * @param bar The Bar, that triggered this event.
     491
     492   @todo canceling a session in non-threaded mode.
    493493*/
    494494gint GuiUpdate::cancelDownload(GtkWidget* w, GdkEventKey* event, void* bar)

  • orxonox/trunk/src/lib/gui/gui_update.h

    r4746 r4836  
    5151  Button* updateDataBegin;              //!< A Button to start the process.
    5252
    53   Button* updateSourceWindowButton;     //!< A Button to update the Source of orxonox. \todo tricky
     53  Button* updateSourceWindowButton;     //!< A Button to update the Source of orxonox. @todo tricky
    5454  Window* updateSourceWindow;           //!< A Window for the Source-update.
    5555  Box* updateSourceBox;                 //!< A Box for the Window for the Source-update.

  • orxonox/trunk/src/lib/gui/gui_video.cc

    r4777 r4836  
    3232
    3333/**
    34    \brief Creates the Video-Option-Frame
     34 * Creates the Video-Option-Frame
    3535*/
    3636GuiVideo::GuiVideo()
    … …  
    7474
    7575/**
    76    \brief Destructs the Video-stuff
     76 * Destructs the Video-stuff
    7777*/
    7878GuiVideo::~GuiVideo()
    … …  
    8282
    8383/**
    84    \brief Creates a window, and all it contains for the Source-update.
     84 * Creates a window, and all it contains for the Source-update.
    8585*/
    8686Widget* GuiVideo::advancedWindowCreate()
    … …  
    185185
    186186/**
    187    \brief sets all resolutions to the menu
    188    \param menu the Menu to set The resolutions to.
     187 * sets all resolutions to the menu
     188 * @param menu the Menu to set The resolutions to.
    189189*/
    190190void GuiVideo::getResolutions(Menu* menu)
Note: See TracChangeset for help on using the changeset viewer.