Minor improvements to Doxygen docs (woot, Doxygen 1.7 looks great\!)

git-svn-id: svn+ssh://svn.code.sf.net/p/supertuxkart/code/main/trunk@8177 178a84e3-b1eb-0310-8ba1-8eac791a3b58
This commit is contained in:
auria 2011-04-01 15:46:38 +00:00
parent d1126e12c9
commit d58bfca783
4 changed files with 22 additions and 15 deletions

View File

@ -28,6 +28,13 @@ namespace GUIEngine
{
class Widget;
/**
* \brief Represents a GUI widgets container.
*
* Abstract base class for both Screen and ModalDialog.
*
* \ingroup guiengine
*/
class AbstractTopLevelContainer
{
protected:

View File

@ -312,8 +312,8 @@ namespace GUIEngine
bool isBottomBar() const { return m_bottom_bar; }
/**
* \{
* \name Enabling or disabling widgets
* \{
*/
/** \brief undos setDeactivated() */
@ -328,8 +328,8 @@ namespace GUIEngine
*/
/**
* \{
* \name Accessing the underlying irrlicht element
* \{
*/
/**
@ -379,12 +379,11 @@ namespace GUIEngine
*/
/**
* \{
* \name Get and set properties
*
* Note that many properties are read only by the Widget::add method; so, while
* it will generally work to set the properties before add() is called, modifying
* the widget after it was added will require other widget-specific calls.
* \{
*/
/** A map that holds values for all specified widget properties (in the XML file)*/
@ -422,8 +421,8 @@ namespace GUIEngine
*/
/**
* \{
* \name Focus management
* \{
*/
/**
@ -447,14 +446,13 @@ namespace GUIEngine
*/
/**
* \{
* \name ID Counter Functions
*
* Functions used to generate IDs for new widgets. The domain of each ID
* encodes whether the widget can receive focus or not (this was implemented
* this way because navigation in irrlicht happens between sequential IDs; so
* to prevent navigation to a widget, one needs to give an ID that is not
* sequential with focusable widgets in order not to break keyboard navigation).
* \{
*/
static void resetIDCounters();
@ -482,10 +480,9 @@ namespace GUIEngine
*/
/**
* \{
* \name Handling children
*
* If this widget is a container and has children.
* \{
*/
/**
@ -506,8 +503,7 @@ namespace GUIEngine
/**
* \{
* \name Callbacks for implementating classes
*
* \name Callbacks for subclasses
* Classes that subclass Widget to provide actual implementations may override/implement these
* methods to change behaviour or be notified of some events.
*/
@ -550,10 +546,9 @@ namespace GUIEngine
*/
/**
* \{
* \name Badge support
*
* "Badges" are icons that can appear on top of some widgets.
* \{
*/
/**
@ -597,9 +592,8 @@ namespace GUIEngine
*/
/**
* \{
* \name Tooltip support
*
* \{
*/

View File

@ -29,6 +29,9 @@
#include "guiengine/modaldialog.hpp"
#include "utils/synchronised.hpp"
/**
* \ingroup states_screens
*/
class AddonsLoading : public GUIEngine::ModalDialog
{
//virtual void escapePressed() {};

View File

@ -23,6 +23,9 @@
namespace irr { namespace video { class ITexture; } }
/**
* \ingroup states_screens
*/
class RaceOverDialog : public GUIEngine::ModalDialog
{
void renderThreeStrikesGraph(const int x, const int y, const int w, const int h);