mirrors/SFML
1
0
Fork 0
mirror of https://github.com/SFML/SFML.git synced 2024-12-01 15:51:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

Minor correction in API documentation

Browse Source
This commit is contained in:
Laurent Gomila 2012-07-10 20:22:08 +02:00
parent faf8a233db
commit e7284cd665
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/SFML/Window/Window.hpp
View File

@ -178,11 +178,11 @@ public :
const ContextSettings& getSettings() const; const ContextSettings& getSettings() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Pop the event on top of events stack, if any, and return it /// \brief Pop the event on top of the event queue, if any, and return it
/// ///
/// This function is not blocking: if there's no pending event then /// This function is not blocking: if there's no pending event then
/// it will return false and leave \a event unmodified. /// it will return false and leave \a event unmodified.
/// Note that more than one event may be present in the events stack, /// Note that more than one event may be present in the event queue,
/// thus you should always call this function in a loop /// thus you should always call this function in a loop
/// to make sure that you process every pending event. /// to make sure that you process every pending event.
/// \code /// \code
@ -195,7 +195,7 @@ public :
/// ///
/// \param event Event to be returned /// \param event Event to be returned
/// ///
/// \return True if an event was returned, or false if the events stack was empty /// \return True if an event was returned, or false if the event queue was empty
/// ///
/// \see waitEvent /// \see waitEvent
/// ///