ilikecats/stk-code_catmod
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Oops, in Doxygen the tag for preconditions is \pre

Browse Source 
git-svn-id: svn+ssh://svn.code.sf.net/p/supertuxkart/code/main/trunk@8311 178a84e3-b1eb-0310-8ba1-8eac791a3b58
This commit is contained in:
auria 2011-04-12 20:42:57 +00:00
parent 0ce0edf779
commit 719e9c3622
10 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/graphics/irr_driver.hpp
View File

@ -209,7 +209,7 @@ public:
* \param mesh_location Location of each fo these meshes
* \param model_frames For animated meshes, which frame to use (value can be -1 to set none)
* When frame is not -1, the corresponding IMesh must be an IAnimatedMesh.
* \precondition The 3 vectors have the same size.
* \pre The 3 vectors have the same size.
*/
void setupRTTScene(PtrVector<scene::IMesh, REF>& mesh,
AlignedArray<Vec3>& mesh_location,

6
src/guiengine/engine.hpp
View File

@ -95,7 +95,7 @@ namespace GUIEngine
/**
* \brief Call this method to init the GUI engine.
* \precondition A irrlicht device and its corresponding video drivers must have been created
* \pre A irrlicht device and its corresponding video drivers must have been created
* \param device An initialized irrlicht device object
* \param driver An initialized irrlicht driver object
* \param state_manager An instance of a class derived from abstract base AbstractStateManager
@ -151,7 +151,7 @@ namespace GUIEngine
void clearScreenCache();
/**
* \precondition GUIEngine::init must have been called first
* \pre GUIEngine::init must have been called first
* \return the skin object used to render widgets
*/
inline Skin* getSkin() { return Private::g_skin; }
@ -168,7 +168,7 @@ namespace GUIEngine
int getSmallFontHeight();
/**
* \precondition the value returned by this function is only valid when invoked from GUIEngine::render
* \pre the value returned by this function is only valid when invoked from GUIEngine::render
* \return the time delta between the last two frames
*/
float getLatestDt();

2
src/guiengine/screen.hpp
View File

@ -181,7 +181,7 @@ namespace GUIEngine
/**
* \brief callback invoked when loading this menu
*
* \precondition Children widgets of this menu have been created by the time this callback
* \pre Children widgets of this menu have been created by the time this callback
* is invoked.
* \note this method is not called everytime the screen is shown. Screen::init is.
* use this method for persistent setup code (namely, that deals with settupping

2
src/guiengine/widget.hpp
View File

@ -425,7 +425,7 @@ namespace GUIEngine
/**
* Get the irrlicht widget ID attributed to this widget
* \precondition Only call this method after the widget has been add()ed
* \pre Only call this method after the widget has been add()ed
*/
int getID() const { return m_id; }

2
src/guiengine/widgets/button_widget.hpp
View File

@ -46,7 +46,7 @@ namespace GUIEngine
/**
* \brief Change the label on the button
* \precondition This should only be called after a widget has been add()ed (changing the label
* \pre This should only be called after a widget has been add()ed (changing the label
* before the widget is added can be done by editing the 'text' property of Widget).
*/
void setLabel(const irr::core::stringw &label);

6
src/guiengine/widgets/icon_button_widget.hpp
View File

@ -85,14 +85,14 @@ namespace GUIEngine
* visited, the previous label will be back. For a permanent change, edit the 'text'
* property in the base Widget class).
*
* \precondition Must be called after this widget is add()ed to have any effect
* \pre Must be called after this widget is add()ed to have any effect
* \note Calling this method on a button without label will have no effect
*/
void setLabel(irr::core::stringw new_label);
/**
* Change the texture used for this icon.
* \precondition At the moment, the new texture must have the same aspct ratio
* \pre At the moment, the new texture must have the same aspct ratio
* as the previous one since the object will not
* be resized to fit a different aspect ratio.
* \note May safely be called no matter if the widget is add()ed or not
@ -101,7 +101,7 @@ namespace GUIEngine
/**
* Change the texture used for this icon.
* \precondition At the moment, the new texture must have the same aspct ratio
* \pre At the moment, the new texture must have the same aspct ratio
* as the previous one since the object will not
* be resized to fit a different aspect ratio.
* \note May safely be called no matter if the widget is add()ed or not

2
src/guiengine/widgets/label_widget.hpp
View File

@ -97,7 +97,7 @@ namespace GUIEngine
/**
* \brief Check if the current has been fully scrolled
* \return true if the text has completely scrolled off
* \precondition May only be called after this widget has been add()ed
* \pre May only be called after this widget has been add()ed
*/
bool scrolledOff() const;

22
src/guiengine/widgets/list_widget.hpp
View File

@ -71,7 +71,7 @@ namespace GUIEngine
*
* \note the list widget does NOT take ownership of the bank, dso you must delete it when
* you're done with it (but do not delete it when the list widget is still active)
* \precondition may only be called after the widget has been added to the screen with add()
* \pre may only be called after the widget has been added to the screen with add()
*/
void setIcons(irr::gui::STKModifiedSpriteBank* icons);
@ -82,32 +82,32 @@ namespace GUIEngine
* \brief add an item to the list
* \param name user-visible, potentially translated, name of the item
* \param icon ID of the icon within the icon bank. Only used if an icon bank was passed.
* \precondition may only be called after the widget has been added to the screen with add()
* \pre may only be called after the widget has been added to the screen with add()
*/
void addItem(const std::string& internal_name,
const irr::core::stringw &name, const int icon=-1);
/**
* \brief erases all items in the list
* \precondition may only be called after the widget has been added to the screen with add()
* \pre may only be called after the widget has been added to the screen with add()
*/
void clear();
/**
* \return the number of items in the list
* \precondition may only be called after the widget has been added to the screen with add()
* \pre may only be called after the widget has been added to the screen with add()
*/
int getItemCount() const;
/**
* \return the index of the selected element within the list, or -1 if none
* \precondition may only be called after the widget has been added to the screen with add()
* \pre may only be called after the widget has been added to the screen with add()
*/
int getSelectionID() const;
/**
* \return the text of the selected item
* \precondition may only be called after the widget has been added to the screen with add()
* \pre may only be called after the widget has been added to the screen with add()
*/
std::string getSelectionInternalName();
@ -121,19 +121,19 @@ namespace GUIEngine
/**
* \brief change the selected item
* \param index the index of the element to select within the list, or -1 to select nothing
* \precondition may only be called after the widget has been added to the screen with add()
* \pre may only be called after the widget has been added to the screen with add()
*/
void setSelectionID(const int index);
/**
* \brief rename an item and/or change its icon based on its ID
* \precondition may only be called after the widget has been added to the screen with add()
* \pre may only be called after the widget has been added to the screen with add()
*/
void renameItem(const int itemID, const irr::core::stringw newName, const int icon=-1);
/**
* \brief rename an item and/or change its icon based on its internal name
* \precondition may only be called after the widget has been added to the screen with add()
* \pre may only be called after the widget has been added to the screen with add()
*/
void renameItem(const std::string internalName, const irr::core::stringw newName,
const int icon=-1)
@ -145,13 +145,13 @@ namespace GUIEngine
/**
* \brief Make an item red to mark an error, for instance
* \precondition may only be called after the widget has been added to the screen with add()
* \pre may only be called after the widget has been added to the screen with add()
*/
void markItemRed(const int id);
/**
* \brief Make an item red to mark an error, for instance
* \precondition may only be called after the widget has been added to the screen with add()
* \pre may only be called after the widget has been added to the screen with add()
*/
void markItemRed(const std::string internalName)
{

12
src/guiengine/widgets/ribbon_widget.hpp
View File

@ -125,7 +125,7 @@ namespace GUIEngine
* \brief This method can be used to rename an item.
* Has no effect for ribbons without individual labels.
*
* \precondition Must be called after the ribbon was add()ed
* \pre Must be called after the ribbon was add()ed
* \param id The index of the item to rename, in range [0 .. item count - 1]
*/
void setLabel(const int id, irr::core::stringw new_name);
@ -134,15 +134,15 @@ namespace GUIEngine
int findItemNamed(const char* internalName);
/** \brief dynamically (at runtime) add a text item to this ribbon
* \precondition this must be called before RibbonWidget::add, while the widget is not yet displayed
* \precondition only valid for ribbons that take text-only contents (e.g. tab bars)
* \pre this must be called before RibbonWidget::add, while the widget is not yet displayed
* \pre only valid for ribbons that take text-only contents (e.g. tab bars)
*/
void addTextChild(const wchar_t* text, const std::string id);
/** \brief dynamically (at runtime) add an icon item to this ribbon
* \precondition this must be called before RibbonWidget::add, while the widget is not yet displayed
* \precondition only valid for ribbons that take icon contents
* \pre this must be called before RibbonWidget::add, while the widget is not yet displayed
* \pre only valid for ribbons that take icon contents
*/
void addIconChild(const wchar_t* text, const std::string id,
const int w, const int h, const std::string icon,
@ -150,7 +150,7 @@ namespace GUIEngine
/**
* \brief clear all children of this ribbon (likely because new ones will be added soon after)
* \precondition this must be called before RibbonWidget::add, while the widget is not yet displayed
* \pre this must be called before RibbonWidget::add, while the widget is not yet displayed
*/
void clearAllChildren();

2
src/guiengine/widgets/spinner_widget.hpp
View File

@ -106,7 +106,7 @@ namespace GUIEngine
/**
* \brief sets the current value of the spinner
* \precondition the 'new_value' string passed must be the name of an item
* \pre the 'new_value' string passed must be the name of an item
* (added through SpinnerWidget::addLabel)in the spinner
*/
void setValue(irr::core::stringw new_value);