From e42823a7dcc8bb8555f005fbbc20f597611c103a Mon Sep 17 00:00:00 2001 From: Chris Thrasher Date: Mon, 9 Sep 2024 19:51:30 -0600 Subject: [PATCH] Improve documentation wording --- include/SFML/Audio/Listener.hpp | 4 ++-- include/SFML/Audio/SoundBufferRecorder.hpp | 2 +- include/SFML/Audio/SoundStream.hpp | 2 +- include/SFML/Graphics/Shape.hpp | 4 ++-- include/SFML/Graphics/Sprite.hpp | 2 +- include/SFML/Graphics/Text.hpp | 2 +- include/SFML/Graphics/View.hpp | 2 +- include/SFML/Network/Packet.hpp | 4 ++-- include/SFML/Network/SocketSelector.hpp | 2 +- include/SFML/System/FileInputStream.hpp | 2 +- include/SFML/System/MemoryInputStream.hpp | 2 +- include/SFML/System/Time.hpp | 2 +- include/SFML/Window/ContextSettings.hpp | 2 +- include/SFML/Window/VideoMode.hpp | 2 +- src/SFML/Window/macOS/SFWindow.h | 4 ++-- 15 files changed, 19 insertions(+), 19 deletions(-) diff --git a/include/SFML/Audio/Listener.hpp b/include/SFML/Audio/Listener.hpp index 81c179461..3d045945b 100644 --- a/include/SFML/Audio/Listener.hpp +++ b/include/SFML/Audio/Listener.hpp @@ -215,8 +215,8 @@ SFML_AUDIO_API void setUpVector(const Vector3f& upVector); /// `sf::Listener` are their ears (by the way, they are often linked /// together -- same position, orientation, etc.). /// -/// `sf::Listener` is a simple interface, which allows to setup the -/// listener in the 3D audio environment (position, direction and +/// `sf::Listener` is a simple interface, which allows for setting up +/// the listener in the 3D audio environment (position, direction and /// up vector), and to adjust the global volume. /// /// Usage example: diff --git a/include/SFML/Audio/SoundBufferRecorder.hpp b/include/SFML/Audio/SoundBufferRecorder.hpp index 116ea800e..3b9e0bde7 100644 --- a/include/SFML/Audio/SoundBufferRecorder.hpp +++ b/include/SFML/Audio/SoundBufferRecorder.hpp @@ -108,7 +108,7 @@ private: /// \class sf::SoundBufferRecorder /// \ingroup audio /// -/// `sf::SoundBufferRecorder` allows to access a recorded sound +/// `sf::SoundBufferRecorder` allows for accessing a recorded sound /// through a `sf::SoundBuffer`, so that it can be played, saved /// to a file, etc. /// diff --git a/include/SFML/Audio/SoundStream.hpp b/include/SFML/Audio/SoundStream.hpp index 12ee9c711..0f4992eda 100644 --- a/include/SFML/Audio/SoundStream.hpp +++ b/include/SFML/Audio/SoundStream.hpp @@ -311,7 +311,7 @@ private: /// Unlike audio buffers (see `sf::SoundBuffer`), audio streams /// are never completely loaded in memory. Instead, the audio /// data is acquired continuously while the stream is playing. -/// This behavior allows to play a sound with no loading delay, +/// This behavior allows for playing a sound with no loading delay, /// and keeps the memory consumption very low. /// /// Sound sources that need to be streamed are usually big files diff --git a/include/SFML/Graphics/Shape.hpp b/include/SFML/Graphics/Shape.hpp index 6cffac5b3..1256fa51b 100644 --- a/include/SFML/Graphics/Shape.hpp +++ b/include/SFML/Graphics/Shape.hpp @@ -328,8 +328,8 @@ private: /// \class sf::Shape /// \ingroup graphics /// -/// `sf::Shape` is a drawable class that allows to define and -/// display a custom convex shape on a render target. +/// `sf::Shape` is a drawable class that allows for defining and +/// displaying a custom convex shape on a render target. /// It's only an abstract base, it needs to be specialized for /// concrete types of shapes (circle, rectangle, convex polygon, /// star, ...). diff --git a/include/SFML/Graphics/Sprite.hpp b/include/SFML/Graphics/Sprite.hpp index 4a780b80d..10608b5be 100644 --- a/include/SFML/Graphics/Sprite.hpp +++ b/include/SFML/Graphics/Sprite.hpp @@ -231,7 +231,7 @@ private: /// \class sf::Sprite /// \ingroup graphics /// -/// `sf::Sprite` is a drawable class that allows to easily display +/// `sf::Sprite` is a drawable class that allows for easily displaying /// a texture (or a part of it) on a render target. /// /// It inherits all the functions from `sf::Transformable`: diff --git a/include/SFML/Graphics/Text.hpp b/include/SFML/Graphics/Text.hpp index e495a64a9..9bc56ea06 100644 --- a/include/SFML/Graphics/Text.hpp +++ b/include/SFML/Graphics/Text.hpp @@ -435,7 +435,7 @@ private: /// \class sf::Text /// \ingroup graphics /// -/// `sf::Text` is a drawable class that allows to easily display +/// `sf::Text` is a drawable class that allows for easily displaying /// some text with custom style and color on a render target. /// /// It inherits all the functions from `sf::Transformable`: diff --git a/include/SFML/Graphics/View.hpp b/include/SFML/Graphics/View.hpp index 450973f0c..9e590baa8 100644 --- a/include/SFML/Graphics/View.hpp +++ b/include/SFML/Graphics/View.hpp @@ -286,7 +286,7 @@ private: /// which defines where the contents of the source rectangle /// will be displayed on the render target (window or texture). /// -/// The viewport allows to map the scene to a custom part +/// The viewport allows for mapping the scene to a custom part /// of the render target, and can be used for split-screen /// or for displaying a minimap, for example. If the source /// rectangle doesn't have the same size as the viewport, its diff --git a/include/SFML/Network/Packet.hpp b/include/SFML/Network/Packet.hpp index c246a8934..9aae5adea 100644 --- a/include/SFML/Network/Packet.hpp +++ b/include/SFML/Network/Packet.hpp @@ -165,7 +165,7 @@ public: //////////////////////////////////////////////////////////// /// \brief Test the validity of the packet, for reading /// - /// This operator allows to test the packet as a boolean + /// This operator allows for testing the packet as a boolean /// variable, to check if a reading operation was successful. /// /// A packet will be in an invalid state if it has no more @@ -513,7 +513,7 @@ private: /// } /// \endcode /// -/// Packets also provide an extra feature that allows to apply +/// Packets also provide an extra feature that allows for applying /// custom transformations to the data before it is sent, /// and after it is received. This is typically used to /// handle automatic compression or encryption of the data. diff --git a/include/SFML/Network/SocketSelector.hpp b/include/SFML/Network/SocketSelector.hpp index 8b8f93948..9bbada896 100644 --- a/include/SFML/Network/SocketSelector.hpp +++ b/include/SFML/Network/SocketSelector.hpp @@ -39,7 +39,7 @@ namespace sf class Socket; //////////////////////////////////////////////////////////// -/// \brief Multiplexer that allows to read from multiple sockets +/// \brief Multiplexer that allows for reading from multiple sockets /// //////////////////////////////////////////////////////////// class SFML_NETWORK_API SocketSelector diff --git a/include/SFML/System/FileInputStream.hpp b/include/SFML/System/FileInputStream.hpp index b9a80144d..ddcc19619 100644 --- a/include/SFML/System/FileInputStream.hpp +++ b/include/SFML/System/FileInputStream.hpp @@ -186,7 +186,7 @@ private: /// reads from a file on disk. /// /// It wraps a file in the common `InputStream` interface -/// and therefore allows to use generic classes or functions +/// and therefore allows for using generic classes or functions /// that accept such a stream, with a file on disk as the data /// source. /// diff --git a/include/SFML/System/MemoryInputStream.hpp b/include/SFML/System/MemoryInputStream.hpp index cd8ad54c9..5a24badc4 100644 --- a/include/SFML/System/MemoryInputStream.hpp +++ b/include/SFML/System/MemoryInputStream.hpp @@ -115,7 +115,7 @@ private: /// reads from data in memory. /// /// It wraps a memory chunk in the common `InputStream` interface -/// and therefore allows to use generic classes or functions +/// and therefore allows for using generic classes or functions /// that accept such a stream, with content already loaded in memory. /// /// In addition to the virtual functions inherited from diff --git a/include/SFML/System/Time.hpp b/include/SFML/System/Time.hpp index 0b5c192d0..d95b79dcd 100644 --- a/include/SFML/System/Time.hpp +++ b/include/SFML/System/Time.hpp @@ -452,7 +452,7 @@ constexpr Time& operator%=(Time& left, Time right); /// \ingroup system /// /// `sf::Time` encapsulates a time value in a flexible way. -/// It allows to define a time value either as a number of +/// It allows for defining a time value either as a number of /// seconds, milliseconds or microseconds. It also works the /// other way round: you can read a time value as either /// a number of seconds, milliseconds or microseconds. It diff --git a/include/SFML/Window/ContextSettings.hpp b/include/SFML/Window/ContextSettings.hpp index f23378b4b..b1864748b 100644 --- a/include/SFML/Window/ContextSettings.hpp +++ b/include/SFML/Window/ContextSettings.hpp @@ -68,7 +68,7 @@ struct ContextSettings /// \class sf::ContextSettings /// \ingroup window /// -/// ContextSettings allows to define several advanced settings +/// ContextSettings allows for defining several advanced settings /// of the OpenGL context attached to a window. All these /// settings with the exception of the compatibility flag /// and anti-aliasing level have no impact on the regular diff --git a/include/SFML/Window/VideoMode.hpp b/include/SFML/Window/VideoMode.hpp index 510f0a3bd..f8f9a4bfe 100644 --- a/include/SFML/Window/VideoMode.hpp +++ b/include/SFML/Window/VideoMode.hpp @@ -201,7 +201,7 @@ public: /// /// Additionally, `sf::VideoMode` provides a static function /// to get the mode currently used by the desktop: `getDesktopMode()`. -/// This allows to build windows with the same size or pixel +/// This allows for building windows with the same size or pixel /// depth as the current resolution. /// /// Usage example: diff --git a/src/SFML/Window/macOS/SFWindow.h b/src/SFML/Window/macOS/SFWindow.h index 975f6fa30..49ad2f771 100644 --- a/src/SFML/Window/macOS/SFWindow.h +++ b/src/SFML/Window/macOS/SFWindow.h @@ -35,7 +35,7 @@ @interface SFWindow : NSWindow //////////////////////////////////////////////////////////// -/// \brief Allow to grab fullscreen events +/// \brief Allow for grabbing fullscreen events /// /// acceptsFirstResponder and canBecomeKeyWindow messages must /// return YES to grab fullscreen events. @@ -48,7 +48,7 @@ - (BOOL)acceptsFirstResponder; //////////////////////////////////////////////////////////// -/// \brief Allow to grab fullscreen events +/// \brief Allow for grabbing fullscreen events /// /// See acceptsFirstResponder documentation above. ///