Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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


Ignore:
Timestamp:
Dec 15, 2004, 9:00:38 PM (19 years ago)
Author:
bensch
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/gui/orxonox_gui_gtk.cc

    r3166 r3187  
    4040
    4141#ifdef HAVE_GTK2
     42/**
     43   \brief Initializes the Guis GTK-stuff.
     44   \param argc the argument count.
     45   \param argv The Argument strings.
     46*/
    4247bool initGTK(int argc, char *argv[])
    4348{
    … …  
    4550  gtk_rc_parse( "rc" );
    4651}
     52
     53/**
     54   \brief enters the GTK-main-loop
     55*/
    4756bool mainloopGTK(void)
    4857{
    … …  
    158167/**
    159168   \brief Moves through all the Widgets downwards from this and executes the function on them.
    160    \param function must be of type void and takes a Widget* as an Input.
     169   \param Function must be of type void and takes a Widget* as an Input.
    161170*/
    162171void Widget::walkThrough (void (*function)(Widget*))
    … …  
    197206
    198207#ifdef HAVE_GTK2
     208
     209/**
     210   \brief Signal that does absolutely nothing
     211   \param widget The widget that initiated the Signal
     212   \param event The event-type.
     213   \param nothing nothin.
     214*/
    199215gint Widget::doNothingSignal (GtkWidget *widget, GdkEvent* event, void* nothing)
    200216{
    … …  
    209225/**
    210226   \brief Initializes a Packer.
     227
    211228   Sets the down-pinter to NULL and other PackerSpecific-values to their defaults.
    212229*/
    … …  
    246263/**
    247264   \brief Initializes a Container.
     265
    248266   sets the Container-Specific defaults.
    249267*/
    … …  
    259277/**
    260278   \briefFills a Container with lowerWidget.
     279   \param lowerWidget the Widget that should be filled into the Container.
     280
    261281   It does this by filling up the down pointer only if down points to NULL.
    262    \param lowerWidget the Widget that should be filled into the Container.
    263282*/
    264283void Container::fill (Widget *lowerWidget)
    … …  
    281300Window* Window::mainWindow = NULL;
    282301
     302/**
     303   \brief Adds a new Window Windows to the List of Windows.
     304   \param windowToAdd The Windows that should be added to the List
     305   \todo this instead of windowToAdd (possibly)
     306*/
    283307void Window::addWindow(Window* windowToAdd)
    284308{
    … …  
    410434   \brief opens up a window (not topmost Window).
    411435   this is the Signal that does it. !!SIGNALS ARE STATIC!!
    412    \param widget the widget that did it!
    413    \param event the event that did it!
     436   \param widget the widget that did it.
     437   \param event the event that did it.
    414438   \param window the Window that should be opened
    415439*/
    … …  
    585609/**
    586610    \brief Fills a box with a given Widget.
     611    \param lowerWidget the next Widget that should be appendet to this Box
     612
    587613    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
    588     \param lowerWidget the next Widget that should be appendet to this Box
    589614*/
    590615void Box::fill (Widget *lowerWidget)
    … …  
    658683/**
    659684   \brief This sets The FlagName of an Option and defines its default Values
    660    !! Options will be saved if flagname is different from "" !!
     685   !! Options will be saved if flagname is different from NULL !!
    661686   \param flagname the Name that will be displayed in the output
    662687   \param defaultvalue the default Value for this Option (see definition of defaultvalue
    … …  
    9951020}
    9961021
     1022/**
     1023   \brief Creates a new OptionLabel with a LabelName and a Value.
     1024   \param label The name of the OptionLabel.
     1025   \param value The Value of the OptionLabel (what will be displayed).
     1026*/
    9971027OptionLabel::OptionLabel(char* label, char* value)
    9981028{
    … …  
    10021032}
    10031033
     1034/**
     1035   \brief Initializes an OptionLabel
     1036*/
    10041037void OptionLabel::init(void)
    10051038{
    … …  
    10131046}
    10141047
     1048/**
     1049   \brief Updates the value of an OptionLabel
     1050   \param newValue The new Name that should be displayed.
     1051*/
    10151052void OptionLabel::setValue(char* newValue)
    10161053{
    … …  
    10241061}
    10251062
     1063/**
     1064   \brief Sets a ned Title to the OptionLabel.
     1065   \param title The now title of the OptionLabel.
     1066*/
    10261067void OptionLabel::setTitle(char* title)
    10271068{
    … …  
    10351076}
    10361077
     1078/**
     1079   \brief Redraws an OptionLabel (not implemented yet, but it works).
     1080*/
    10371081void OptionLabel::redraw(void)
    10381082{
Note: See TracChangeset for help on using the changeset viewer.