mirrors/SFML
1
0
Fork 0
mirror of https://github.com/SFML/SFML.git synced 2024-11-24 20:31:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Remove backticks which are not correctly formatted

Browse Source
This commit is contained in:
Chris Thrasher 2024-11-17 10:40:51 -07:00
parent e21ba4dc95
commit d8c66ffc8d
11 changed files with 39 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/SFML/Audio/InputSoundFile.hpp
View File

@ -73,7 +73,7 @@ public:
///
/// \param filename Path of the sound file to load
///
/// \throws `sf::Exception` if opening the file was unsuccessful
/// \throws sf::Exception if opening the file was unsuccessful
///
////////////////////////////////////////////////////////////
explicit InputSoundFile(const std::filesystem::path& filename);
@ -87,7 +87,7 @@ public:
/// \param data Pointer to the file data in memory
/// \param sizeInBytes Size of the data to load, in bytes
///
/// \throws `sf::Exception` if opening the file was unsuccessful
/// \throws sf::Exception if opening the file was unsuccessful
///
////////////////////////////////////////////////////////////
InputSoundFile(const void* data, std::size_t sizeInBytes);
@ -100,7 +100,7 @@ public:
///
/// \param stream Source stream to read from
///
/// \throws `sf::Exception` if opening the file was unsuccessful
/// \throws sf::Exception if opening the file was unsuccessful
///
////////////////////////////////////////////////////////////
explicit InputSoundFile(InputStream& stream);

6
include/SFML/Audio/Music.hpp
View File

@ -88,7 +88,7 @@ public:
///
/// \param filename Path of the music file to open
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `openFromMemory`, `openFromStream`
///
@ -111,7 +111,7 @@ public:
/// \param data Pointer to the file data in memory
/// \param sizeInBytes Size of the data to load, in bytes
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `openFromFile`, `openFromStream`
///
@ -132,7 +132,7 @@ public:
///
/// \param stream Source stream to read from
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `openFromFile`, `openFromMemory`
///

2
include/SFML/Audio/OutputSoundFile.hpp
View File

@ -67,7 +67,7 @@ public:
/// \param channelCount Number of channels in the sound
/// \param channelMap Map of position in sample frame to sound channel
///
/// \throws `sf::Exception` if the file could not be opened successfully
/// \throws sf::Exception if the file could not be opened successfully
///
////////////////////////////////////////////////////////////
OutputSoundFile(const std::filesystem::path& filename,

8
include/SFML/Audio/SoundBuffer.hpp
View File

@ -79,7 +79,7 @@ public:
///
/// \param filename Path of the sound file to load
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromMemory`, `loadFromStream`, `loadFromSamples`, `saveToFile`
///
@ -95,7 +95,7 @@ public:
/// \param data Pointer to the file data in memory
/// \param sizeInBytes Size of the data to load, in bytes
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromStream`, `loadFromSamples`
///
@ -110,7 +110,7 @@ public:
///
/// \param stream Source stream to read from
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromSamples`
///
@ -128,7 +128,7 @@ public:
/// \param sampleRate Sample rate (number of samples to play per second)
/// \param channelMap Map of position in sample frame to sound channel
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `saveToFile`
///

6
include/SFML/Graphics/Font.hpp
View File

@ -95,7 +95,7 @@ public:
///
/// \param filename Path of the font file to open
///
/// \throws `sf::Exception` if opening was unsuccessful
/// \throws sf::Exception if opening was unsuccessful
///
/// \see `openFromFile`, `openFromMemory`, `openFromStream`
///
@ -116,7 +116,7 @@ public:
/// \param data Pointer to the file data in memory
/// \param sizeInBytes Size of the data to load, in bytes
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `openFromFile`, `openFromMemory`, `openFromStream`
///
@ -138,7 +138,7 @@ public:
///
/// \param stream Source stream to read from
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `openFromFile`, `openFromMemory`, `openFromStream`
///

6
include/SFML/Graphics/Image.hpp
View File

@ -95,7 +95,7 @@ public:
///
/// \param filename Path of the image file to load
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`
///
@ -112,7 +112,7 @@ public:
/// \param data Pointer to the file data in memory
/// \param size Size of the data to load, in bytes
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`
///
@ -128,7 +128,7 @@ public:
///
/// \param stream Source stream to read from
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`
///

2
include/SFML/Graphics/RenderTexture.hpp
View File

@ -77,7 +77,7 @@ public:
/// \param size Width and height of the render-texture
/// \param settings Additional settings for the underlying OpenGL texture and context
///
/// \throws `sf::Exception` if creation was unsuccessful
/// \throws sf::Exception if creation was unsuccessful
///
////////////////////////////////////////////////////////////
RenderTexture(Vector2u size, const ContextSettings& settings = {});

18
include/SFML/Graphics/Shader.hpp
View File

@ -139,7 +139,7 @@ public:
/// \param filename Path of the vertex, geometry or fragment shader file to load
/// \param type Type of shader (vertex, geometry or fragment)
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`
///
@ -160,7 +160,7 @@ public:
/// \param vertexShaderFilename Path of the vertex shader file to load
/// \param fragmentShaderFilename Path of the fragment shader file to load
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`
///
@ -182,7 +182,7 @@ public:
/// \param geometryShaderFilename Path of the geometry shader file to load
/// \param fragmentShaderFilename Path of the fragment shader file to load
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`
///
@ -204,7 +204,7 @@ public:
/// \param shader String containing the source code of the shader
/// \param type Type of shader (vertex, geometry or fragment)
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`
///
@ -225,7 +225,7 @@ public:
/// \param vertexShader String containing the source code of the vertex shader
/// \param fragmentShader String containing the source code of the fragment shader
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`
///
@ -247,7 +247,7 @@ public:
/// \param geometryShader String containing the source code of the geometry shader
/// \param fragmentShader String containing the source code of the fragment shader
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`
///
@ -267,7 +267,7 @@ public:
/// \param stream Source stream to read from
/// \param type Type of shader (vertex, geometry or fragment)
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`
///
@ -288,7 +288,7 @@ public:
/// \param vertexShaderStream Source stream to read the vertex shader from
/// \param fragmentShaderStream Source stream to read the fragment shader from
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`
///
@ -310,7 +310,7 @@ public:
/// \param geometryShaderStream Source stream to read the geometry shader from
/// \param fragmentShaderStream Source stream to read the fragment shader from
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`
///

18
include/SFML/Graphics/Texture.hpp
View File

@ -106,7 +106,7 @@ public:
/// \param filename Path of the image file to load
/// \param sRgb `true` to enable sRGB conversion, `false` to disable it
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`, `loadFromImage`
///
@ -129,7 +129,7 @@ public:
/// \param sRgb `true` to enable sRGB conversion, `false` to disable it
/// \param area Area of the image to load
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`, `loadFromImage`
///
@ -146,7 +146,7 @@ public:
/// \param size Size of the data to load, in bytes
/// \param sRgb `true` to enable sRGB conversion, `false` to disable it
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`, `loadFromImage`
///
@ -170,7 +170,7 @@ public:
/// \param sRgb `true` to enable sRGB conversion, `false` to disable it
/// \param area Area of the image to load
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`, `loadFromImage`
///
@ -186,7 +186,7 @@ public:
/// \param stream Source stream to read from
/// \param sRgb `true` to enable sRGB conversion, `false` to disable it
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`, `loadFromImage`
///
@ -209,7 +209,7 @@ public:
/// \param sRgb `true` to enable sRGB conversion, `false` to disable it
/// \param area Area of the image to load
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`, `loadFromImage`
///
@ -225,7 +225,7 @@ public:
/// \param image Image to load into the texture
/// \param sRgb `true` to enable sRGB conversion, `false` to disable it
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`, `loadFromImage`
///
@ -247,7 +247,7 @@ public:
/// \param sRgb `true` to enable sRGB conversion, `false` to disable it
/// \param area Area of the image to load
///
/// \throws `sf::Exception` if loading was unsuccessful
/// \throws sf::Exception if loading was unsuccessful
///
/// \see `loadFromFile`, `loadFromMemory`, `loadFromStream`, `loadFromImage`
///
@ -260,7 +260,7 @@ public:
/// \param size Width and height of the texture
/// \param sRgb `true` to enable sRGB conversion, `false` to disable it
///
/// \throws `sf::Exception` if construction was unsuccessful
/// \throws sf::Exception if construction was unsuccessful
///
////////////////////////////////////////////////////////////
explicit Texture(Vector2u size, bool sRgb = false);

2
include/SFML/System/FileInputStream.hpp
View File

@ -100,7 +100,7 @@ public:
///
/// \param filename Name of the file to open
///
/// \throws `sf::Exception` on error
/// \throws sf::Exception on error
///
////////////////////////////////////////////////////////////
explicit FileInputStream(const std::filesystem::path& filename);

4
include/SFML/Window/Cursor.hpp
View File

@ -171,7 +171,7 @@ public:
/// \param size Width and height of the image
/// \param hotspot (x,y) location of the hotspot
///
/// \throws `sf::Exception` if the cursor could not be constructed
/// \throws sf::Exception if the cursor could not be constructed
///
////////////////////////////////////////////////////////////
Cursor(const std::uint8_t* pixels, Vector2u size, Vector2u hotspot);
@ -186,7 +186,7 @@ public:
///
/// \param type Native system cursor type
///
/// \throws `sf::Exception` if the corresponding cursor
/// \throws sf::Exception if the corresponding cursor
/// is not natively supported by the operating
/// system
///