Update the Doxygen comments for betawidget.

git-svn-id: svn+ssh://svn.gna.org/svn/warzone/trunk@5830 4a71c877-e1ca-e34f-864e-861f7616d084
master
Freddie Witherden 2008-08-16 17:49:52 +00:00
parent 38cef47896
commit dd5a740143
1 changed files with 11 additions and 0 deletions

View File

@ -920,7 +920,15 @@ void widgetDrawMask(widget *self);
void widgetDoDrawMask(widget *self);
/**
* A protected `pure virtual' method which is called to lay out any child
* widgets of self.
*
* This method may fail (return false) if self is not large enough to hold all
* of its children.
*
* @param self The widget whose children should be layed out.
* @return True if the widgets children were successfully layed out, false
* otherwise.
*/
bool widgetDoLayout(widget *self);
@ -933,7 +941,10 @@ bool widgetDoLayout(widget *self);
bool widgetFireCallbacks(widget *self, const event *evt);
/**
* Fires all of the timer event handles for the widget self.
*
* @param self The widget to fire the timer callbacks on.
* @param evt The event to fire the callbacks for.
*/
bool widgetFireTimerCallbacks(widget *self, const event *evt);