From 0757c89d7cc815309876dc0906510a1a422c21c5 Mon Sep 17 00:00:00 2001 From: Laurent Gomila Date: Tue, 10 Jul 2012 20:22:35 +0200 Subject: [PATCH] Minor correction in API documentation --- include/SFML/Graphics/RenderWindow.h | 4 ++-- include/SFML/Window/Window.h | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/include/SFML/Graphics/RenderWindow.h b/include/SFML/Graphics/RenderWindow.h index 911e1c7..d4f07ed 100644 --- a/include/SFML/Graphics/RenderWindow.h +++ b/include/SFML/Graphics/RenderWindow.h @@ -97,12 +97,12 @@ CSFML_GRAPHICS_API sfBool sfRenderWindow_isOpen(const sfRenderWindow* renderWind CSFML_GRAPHICS_API sfContextSettings sfRenderWindow_getSettings(const sfRenderWindow* renderWindow); //////////////////////////////////////////////////////////// -/// \brief Get the event on top of events stack of a render window, if any, and pop it +/// \brief Get the event on top of event queue of a render window, if any, and pop it /// /// \param renderWindow Render window object /// \param event Event to fill, if any /// -/// \return sfTrue if an event was returned, sfFalse if events stack was empty +/// \return sfTrue if an event was returned, sfFalse if event queue was empty /// //////////////////////////////////////////////////////////// CSFML_GRAPHICS_API sfBool sfRenderWindow_pollEvent(sfRenderWindow* renderWindow, sfEvent* event); diff --git a/include/SFML/Window/Window.h b/include/SFML/Window/Window.h index 4ff4883..31529eb 100644 --- a/include/SFML/Window/Window.h +++ b/include/SFML/Window/Window.h @@ -158,18 +158,18 @@ CSFML_WINDOW_API sfBool sfWindow_isOpen(const sfWindow* window); CSFML_WINDOW_API sfContextSettings sfWindow_getSettings(const sfWindow* window); //////////////////////////////////////////////////////////// -/// \brief Pop the event on top of events stack, if any, and return it +/// \brief Pop the event on top of event queue, if any, and return it /// /// This function is not blocking: if there's no pending event then /// 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 /// to make sure that you process every pending event. /// /// \param window Window object /// \param event Event to be returned /// -/// \return sfTrue if an event was returned, or sfFalse if the events stack was empty +/// \return sfTrue if an event was returned, or sfFalse if the event queue was empty /// //////////////////////////////////////////////////////////// CSFML_WINDOW_API sfBool sfWindow_pollEvent(sfWindow* window, sfEvent* event);