From 8074b3a004270aedfc21ad28e272199ac2a56350 Mon Sep 17 00:00:00 2001 From: mgrojo Date: Sun, 11 Feb 2024 19:39:58 +0100 Subject: [PATCH] Minor fixes of the documentation - Parameter names not matching the actual code identifier - Typo in SoundRecorder.h - Missing param in Context.h --- include/SFML/Audio/SoundRecorder.h | 6 +++--- include/SFML/Graphics/RenderTexture.h | 2 +- include/SFML/Graphics/RenderWindow.h | 4 ++-- include/SFML/Window/Context.h | 4 +++- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/include/SFML/Audio/SoundRecorder.h b/include/SFML/Audio/SoundRecorder.h index d26ba0c..6899062 100644 --- a/include/SFML/Audio/SoundRecorder.h +++ b/include/SFML/Audio/SoundRecorder.h @@ -135,11 +135,11 @@ CSFML_AUDIO_API sfBool sfSoundRecorder_isAvailable(void); CSFML_AUDIO_API void sfSoundRecorder_setProcessingInterval(sfSoundRecorder* soundRecorder, sfTime interval); //////////////////////////////////////////////////////////// -/// \brief Get a list of the names of all availabe audio capture devices +/// \brief Get a list of the names of all available audio capture devices /// /// This function returns an array of strings (null terminated), -/// containing the names of all availabe audio capture devices. -/// If no devices are available then NULL is returned. +/// containing the names of all available audio capture devices. +/// If no devices are available, then NULL is returned. /// /// \param count Pointer to a variable that will be filled with the number of modes in the array /// diff --git a/include/SFML/Graphics/RenderTexture.h b/include/SFML/Graphics/RenderTexture.h index e026eb0..ee727c3 100644 --- a/include/SFML/Graphics/RenderTexture.h +++ b/include/SFML/Graphics/RenderTexture.h @@ -237,7 +237,7 @@ CSFML_GRAPHICS_API void sfRenderTexture_drawVertexBuffer(sfRenderTexture* render /// \brief Draw primitives defined by a vertex buffer. /// /// \param renderTexture render texture object -/// \param vertexBuffer Vertex buffer object to draw +/// \param object Vertex buffer object to draw /// \param firstVertex Index of the first vertex to render /// \param vertexCount Number of vertices to render /// \param states Render states to use for drawing diff --git a/include/SFML/Graphics/RenderWindow.h b/include/SFML/Graphics/RenderWindow.h index 65fd8be..9838bbc 100644 --- a/include/SFML/Graphics/RenderWindow.h +++ b/include/SFML/Graphics/RenderWindow.h @@ -479,8 +479,8 @@ CSFML_GRAPHICS_API void sfRenderWindow_drawVertexBuffer(sfRenderWindow* renderWi //////////////////////////////////////////////////////////// /// \brief Draw primitives defined by a vertex buffer. /// -/// \param renderWindow render window object -/// \param vertexBuffer Vertex buffer object to draw +/// \param renderWindow Render window object +/// \param object Vertex buffer object to draw /// \param firstVertex Index of the first vertex to render /// \param vertexCount Number of vertices to render /// \param states Render states to use for drawing diff --git a/include/SFML/Window/Context.h b/include/SFML/Window/Context.h index 647de7f..99b2552 100644 --- a/include/SFML/Window/Context.h +++ b/include/SFML/Window/Context.h @@ -55,7 +55,7 @@ CSFML_WINDOW_API void sfContext_destroy(sfContext* context); //////////////////////////////////////////////////////////// /// \brief Check whether a given OpenGL extension is available. /// -/// \param Name of the extension to check for +/// \param name Name of the extension to check for /// /// \return True if available, false if unavailable /// @@ -86,6 +86,8 @@ CSFML_WINDOW_API GlFunctionPointer sfContext_getFunction(const char* name); //////////////////////////////////////////////////////////// /// \brief Get the settings of the context. /// +/// \param context Context object +/// /// Note that these settings may be different than the ones passed to the /// constructor; they are indeed adjusted if the original settings are not /// directly supported by the system.