Improve documentation wording

This commit is contained in:
Chris Thrasher 2024-09-09 19:51:30 -06:00
parent dab1800f61
commit e42823a7dc
No known key found for this signature in database
GPG Key ID: 56FB686C9DFC8E2C
15 changed files with 19 additions and 19 deletions

View File

@ -215,8 +215,8 @@ SFML_AUDIO_API void setUpVector(const Vector3f& upVector);
/// `sf::Listener` are their ears (by the way, they are often linked /// `sf::Listener` are their ears (by the way, they are often linked
/// together -- same position, orientation, etc.). /// together -- same position, orientation, etc.).
/// ///
/// `sf::Listener` is a simple interface, which allows to setup the /// `sf::Listener` is a simple interface, which allows for setting up
/// listener in the 3D audio environment (position, direction and /// the listener in the 3D audio environment (position, direction and
/// up vector), and to adjust the global volume. /// up vector), and to adjust the global volume.
/// ///
/// Usage example: /// Usage example:

View File

@ -108,7 +108,7 @@ private:
/// \class sf::SoundBufferRecorder /// \class sf::SoundBufferRecorder
/// \ingroup audio /// \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 /// through a `sf::SoundBuffer`, so that it can be played, saved
/// to a file, etc. /// to a file, etc.
/// ///

View File

@ -311,7 +311,7 @@ private:
/// Unlike audio buffers (see `sf::SoundBuffer`), audio streams /// Unlike audio buffers (see `sf::SoundBuffer`), audio streams
/// are never completely loaded in memory. Instead, the audio /// are never completely loaded in memory. Instead, the audio
/// data is acquired continuously while the stream is playing. /// 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. /// and keeps the memory consumption very low.
/// ///
/// Sound sources that need to be streamed are usually big files /// Sound sources that need to be streamed are usually big files

View File

@ -328,8 +328,8 @@ private:
/// \class sf::Shape /// \class sf::Shape
/// \ingroup graphics /// \ingroup graphics
/// ///
/// `sf::Shape` is a drawable class that allows to define and /// `sf::Shape` is a drawable class that allows for defining and
/// display a custom convex shape on a render target. /// displaying a custom convex shape on a render target.
/// It's only an abstract base, it needs to be specialized for /// It's only an abstract base, it needs to be specialized for
/// concrete types of shapes (circle, rectangle, convex polygon, /// concrete types of shapes (circle, rectangle, convex polygon,
/// star, ...). /// star, ...).

View File

@ -231,7 +231,7 @@ private:
/// \class sf::Sprite /// \class sf::Sprite
/// \ingroup graphics /// \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. /// a texture (or a part of it) on a render target.
/// ///
/// It inherits all the functions from `sf::Transformable`: /// It inherits all the functions from `sf::Transformable`:

View File

@ -435,7 +435,7 @@ private:
/// \class sf::Text /// \class sf::Text
/// \ingroup graphics /// \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. /// some text with custom style and color on a render target.
/// ///
/// It inherits all the functions from `sf::Transformable`: /// It inherits all the functions from `sf::Transformable`:

View File

@ -286,7 +286,7 @@ private:
/// which defines where the contents of the source rectangle /// which defines where the contents of the source rectangle
/// will be displayed on the render target (window or texture). /// 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 /// of the render target, and can be used for split-screen
/// or for displaying a minimap, for example. If the source /// or for displaying a minimap, for example. If the source
/// rectangle doesn't have the same size as the viewport, its /// rectangle doesn't have the same size as the viewport, its

View File

@ -165,7 +165,7 @@ public:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Test the validity of the packet, for reading /// \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. /// variable, to check if a reading operation was successful.
/// ///
/// A packet will be in an invalid state if it has no more /// A packet will be in an invalid state if it has no more
@ -513,7 +513,7 @@ private:
/// } /// }
/// \endcode /// \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, /// custom transformations to the data before it is sent,
/// and after it is received. This is typically used to /// and after it is received. This is typically used to
/// handle automatic compression or encryption of the data. /// handle automatic compression or encryption of the data.

View File

@ -39,7 +39,7 @@ namespace sf
class Socket; 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 class SFML_NETWORK_API SocketSelector

View File

@ -186,7 +186,7 @@ private:
/// reads from a file on disk. /// reads from a file on disk.
/// ///
/// It wraps a file in the common `InputStream` interface /// 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 /// that accept such a stream, with a file on disk as the data
/// source. /// source.
/// ///

View File

@ -115,7 +115,7 @@ private:
/// reads from data in memory. /// reads from data in memory.
/// ///
/// It wraps a memory chunk in the common `InputStream` interface /// 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. /// that accept such a stream, with content already loaded in memory.
/// ///
/// In addition to the virtual functions inherited from /// In addition to the virtual functions inherited from

View File

@ -452,7 +452,7 @@ constexpr Time& operator%=(Time& left, Time right);
/// \ingroup system /// \ingroup system
/// ///
/// `sf::Time` encapsulates a time value in a flexible way. /// `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 /// seconds, milliseconds or microseconds. It also works the
/// other way round: you can read a time value as either /// other way round: you can read a time value as either
/// a number of seconds, milliseconds or microseconds. It /// a number of seconds, milliseconds or microseconds. It

View File

@ -68,7 +68,7 @@ struct ContextSettings
/// \class sf::ContextSettings /// \class sf::ContextSettings
/// \ingroup window /// \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 /// of the OpenGL context attached to a window. All these
/// settings with the exception of the compatibility flag /// settings with the exception of the compatibility flag
/// and anti-aliasing level have no impact on the regular /// and anti-aliasing level have no impact on the regular

View File

@ -201,7 +201,7 @@ public:
/// ///
/// Additionally, `sf::VideoMode` provides a static function /// Additionally, `sf::VideoMode` provides a static function
/// to get the mode currently used by the desktop: `getDesktopMode()`. /// 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. /// depth as the current resolution.
/// ///
/// Usage example: /// Usage example:

View File

@ -35,7 +35,7 @@
@interface SFWindow : NSWindow @interface SFWindow : NSWindow
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Allow to grab fullscreen events /// \brief Allow for grabbing fullscreen events
/// ///
/// acceptsFirstResponder and canBecomeKeyWindow messages must /// acceptsFirstResponder and canBecomeKeyWindow messages must
/// return YES to grab fullscreen events. /// return YES to grab fullscreen events.
@ -48,7 +48,7 @@
- (BOOL)acceptsFirstResponder; - (BOOL)acceptsFirstResponder;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Allow to grab fullscreen events /// \brief Allow for grabbing fullscreen events
/// ///
/// See acceptsFirstResponder documentation above. /// See acceptsFirstResponder documentation above.
/// ///