mirror of
https://github.com/SFML/CSFML.git
synced 2026-10-28 21:56:12 +01:00
Minor fixes of the documentation
- Parameter names not matching the actual code identifier - Typo in SoundRecorder.h - Missing param in Context.h
This commit is contained in:
1 parent
b7826c5f9a
commit
8074b3a004
4 files changed
+9
-7
No files matched your search
@@ -135,11 +135,11 @@ CSFML_AUDIO_API sfBool sfSoundRecorder_isAvailable(void);
|
|||||||
CSFML_AUDIO_API void sfSoundRecorder_setProcessingInterval(sfSoundRecorder* soundRecorder, sfTime interval);
|
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),
|
/// This function returns an array of strings (null terminated),
|
||||||
/// containing the names of all availabe audio capture devices.
|
/// containing the names of all available audio capture devices.
|
||||||
/// If no devices are available then NULL is returned.
|
/// 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
|
/// \param count Pointer to a variable that will be filled with the number of modes in the array
|
||||||
///
|
///
|
||||||
|
|||||||
@@ -237,7 +237,7 @@ CSFML_GRAPHICS_API void sfRenderTexture_drawVertexBuffer(sfRenderTexture* render
|
|||||||
/// \brief Draw primitives defined by a vertex buffer.
|
/// \brief Draw primitives defined by a vertex buffer.
|
||||||
///
|
///
|
||||||
/// \param renderTexture render texture object
|
/// \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 firstVertex Index of the first vertex to render
|
||||||
/// \param vertexCount Number of vertices to render
|
/// \param vertexCount Number of vertices to render
|
||||||
/// \param states Render states to use for drawing
|
/// \param states Render states to use for drawing
|
||||||
|
|||||||
@@ -479,8 +479,8 @@ CSFML_GRAPHICS_API void sfRenderWindow_drawVertexBuffer(sfRenderWindow* renderWi
|
|||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
/// \brief Draw primitives defined by a vertex buffer.
|
/// \brief Draw primitives defined by a vertex buffer.
|
||||||
///
|
///
|
||||||
/// \param renderWindow render window object
|
/// \param renderWindow Render window 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 firstVertex Index of the first vertex to render
|
||||||
/// \param vertexCount Number of vertices to render
|
/// \param vertexCount Number of vertices to render
|
||||||
/// \param states Render states to use for drawing
|
/// \param states Render states to use for drawing
|
||||||
|
|||||||
@@ -55,7 +55,7 @@ CSFML_WINDOW_API void sfContext_destroy(sfContext* context);
|
|||||||
////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////
|
||||||
/// \brief Check whether a given OpenGL extension is available.
|
/// \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
|
/// \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.
|
/// \brief Get the settings of the context.
|
||||||
///
|
///
|
||||||
|
/// \param context Context object
|
||||||
|
///
|
||||||
/// Note that these settings may be different than the ones passed to the
|
/// Note that these settings may be different than the ones passed to the
|
||||||
/// constructor; they are indeed adjusted if the original settings are not
|
/// constructor; they are indeed adjusted if the original settings are not
|
||||||
/// directly supported by the system.
|
/// directly supported by the system.
|
||||||
|
|||||||
Reference in new issue
Block a user