diff --git a/doc/doxyfile.in b/doc/doxyfile.in index 5cf4158..1ead205 100644 --- a/doc/doxyfile.in +++ b/doc/doxyfile.in @@ -924,7 +924,7 @@ WARN_IF_UNDOC_ENUM_VAL = NO # Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. # The default value is: NO. -WARN_AS_ERROR = NO +WARN_AS_ERROR = YES # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which diff --git a/include/CSFML/Audio/Music.h b/include/CSFML/Audio/Music.h index ac73bab..6d3cd4c 100644 --- a/include/CSFML/Audio/Music.h +++ b/include/CSFML/Audio/Music.h @@ -143,6 +143,8 @@ CSFML_AUDIO_API sfTime sfMusic_getDuration(const sfMusic* music); //////////////////////////////////////////////////////////// /// \brief Get the positions of the of the sound's looping sequence /// +/// \param music Music object +/// /// \return Loop Time position class. /// /// \warning Since sfMusic_setLoopPoints() performs some adjustments on the @@ -172,6 +174,7 @@ CSFML_AUDIO_API sfTimeSpan sfMusic_getLoopPoints(const sfMusic* music); /// \warning Setting the loop points while the stream's status is Paused /// will set its status to Stopped. The playing offset will be unaffected. /// +/// \param music Music object /// \param timePoints The definition of the loop. Can be any time points within the sound's length /// /// \see getLoopPoints diff --git a/include/CSFML/Audio/Sound.h b/include/CSFML/Audio/Sound.h index fb4ba9e..903716e 100644 --- a/include/CSFML/Audio/Sound.h +++ b/include/CSFML/Audio/Sound.h @@ -38,7 +38,7 @@ //////////////////////////////////////////////////////////// /// \brief Create a new sound /// -/// \param soundBuffer Sound buffer containing the audio data to play with the sound +/// \param buffer Sound buffer containing the audio data to play with the sound /// /// \return A new sfSound object /// diff --git a/include/CSFML/Audio/SoundRecorder.h b/include/CSFML/Audio/SoundRecorder.h index 4308215..c988c68 100644 --- a/include/CSFML/Audio/SoundRecorder.h +++ b/include/CSFML/Audio/SoundRecorder.h @@ -174,8 +174,9 @@ CSFML_AUDIO_API const char* sfSoundRecorder_getDevice(sfSoundRecorder* soundReco /// used for recording. Currently only 16-bit mono and /// 16-bit stereo are supported. /// -/// \param channelCount Number of channels. Currently only -/// mono (1) and stereo (2) are supported. +/// \param soundRecorder Sound recorder object +/// \param channelCount Number of channels. Currently only +/// mono (1) and stereo (2) are supported. /// /// \see sfSoundRecorder_getChannelCount /// diff --git a/include/CSFML/Graphics/RenderWindow.h b/include/CSFML/Graphics/RenderWindow.h index a1f53ee..4b4290f 100644 --- a/include/CSFML/Graphics/RenderWindow.h +++ b/include/CSFML/Graphics/RenderWindow.h @@ -50,6 +50,7 @@ /// \param mode Video mode to use /// \param title Title of the window /// \param style Window style +/// \param state Window state /// \param settings Creation settings (pass NULL to use default values) /// //////////////////////////////////////////////////////////// @@ -66,6 +67,7 @@ CSFML_GRAPHICS_API sfRenderWindow* sfRenderWindow_create( /// \param mode Video mode to use /// \param title Title of the window (UTF-32) /// \param style Window style +/// \param state Window state /// \param settings Creation settings (pass NULL to use default values) /// //////////////////////////////////////////////////////////// @@ -256,7 +258,8 @@ CSFML_GRAPHICS_API void sfRenderWindow_setMouseCursorVisible(sfRenderWindow* ren /// won't have any effect (fullscreen windows always grab the /// cursor). /// -/// \param grabbed true to enable, false to disable +/// \param renderWindow Render window object +/// \param grabbed true to enable, false to disable /// //////////////////////////////////////////////////////////// CSFML_GRAPHICS_API void sfRenderWindow_setMouseCursorGrabbed(sfRenderWindow* renderWindow, bool grabbed); @@ -272,13 +275,14 @@ CSFML_GRAPHICS_API void sfRenderWindow_setMouseCursorGrabbed(sfRenderWindow* ren /// \warning Features related to Cursor are not supported on /// iOS and Android. /// -/// \param cursor Native system cursor type to display +/// \param renderWindow Render window object +/// \param cursor Native system cursor type to display /// /// \see sfCursor_createFromSystem /// \see sfCursor_createFromPixels /// //////////////////////////////////////////////////////////// -CSFML_GRAPHICS_API void sfRenderWindow_setMouseCursor(sfRenderWindow* window, const sfCursor* cursor); +CSFML_GRAPHICS_API void sfRenderWindow_setMouseCursor(sfRenderWindow* renderWindow, const sfCursor* cursor); //////////////////////////////////////////////////////////// /// \brief Enable or disable automatic key-repeat for keydown events diff --git a/include/CSFML/Graphics/Text.h b/include/CSFML/Graphics/Text.h index fd80a9e..1395257 100644 --- a/include/CSFML/Graphics/Text.h +++ b/include/CSFML/Graphics/Text.h @@ -359,6 +359,7 @@ CSFML_GRAPHICS_API void sfText_setOutlineColor(sfText* text, sfColor color); /// Be aware that using a negative value for the outline /// thickness will cause distorted rendering. /// +/// \param text Text object /// \param thickness New outline thickness, in pixels /// /// \see getOutlineThickness diff --git a/include/CSFML/Graphics/Texture.h b/include/CSFML/Graphics/Texture.h index e9ce9c1..498ec36 100644 --- a/include/CSFML/Graphics/Texture.h +++ b/include/CSFML/Graphics/Texture.h @@ -387,6 +387,7 @@ CSFML_GRAPHICS_API unsigned int sfTexture_getNativeHandle(const sfTexture* textu /// \endcode /// /// \param texture Pointer to the texture to bind, can be null to use no texture +/// \param type Type of texture coordinates to use /// //////////////////////////////////////////////////////////// CSFML_GRAPHICS_API void sfTexture_bind(const sfTexture* texture, sfTextureCoordinateType type); diff --git a/include/CSFML/Graphics/VertexBuffer.h b/include/CSFML/Graphics/VertexBuffer.h index aa224ea..33a433f 100644 --- a/include/CSFML/Graphics/VertexBuffer.h +++ b/include/CSFML/Graphics/VertexBuffer.h @@ -123,9 +123,10 @@ CSFML_GRAPHICS_API size_t sfVertexBuffer_getVertexCount(const sfVertexBuffer* ve /// array, passing invalid arguments will lead to undefined /// behavior. /// -/// \param vertices Array of vertices to copy to the buffer -/// \param vertexCount Number of vertices to copy -/// \param offset Offset in the buffer to copy to +/// \param vertexBuffer Vertex buffer object +/// \param vertices Array of vertices to copy to the buffer +/// \param vertexCount Number of vertices to copy +/// \param offset Offset in the buffer to copy to /// /// \return true if the update was successful /// diff --git a/include/CSFML/Network/UdpSocket.h b/include/CSFML/Network/UdpSocket.h index 0accf5f..9e21e1d 100644 --- a/include/CSFML/Network/UdpSocket.h +++ b/include/CSFML/Network/UdpSocket.h @@ -196,6 +196,7 @@ CSFML_NETWORK_API sfSocketStatus /// In blocking mode, this function will wait until the whole packet /// has been received. /// +/// \param socket UDP socket object /// \param packet Packet to fill with the received data /// \param remoteAddress Address of the peer that sent the data /// \param remotePort Port of the peer that sent the data diff --git a/include/CSFML/Window/Window.h b/include/CSFML/Window/Window.h index b0c6464..ad44900 100644 --- a/include/CSFML/Window/Window.h +++ b/include/CSFML/Window/Window.h @@ -345,6 +345,7 @@ CSFML_WINDOW_API void sfWindow_setMouseCursorVisible(sfWindow* window, bool visi /// won't have any effect (fullscreen windows always grab the /// cursor). /// +/// \param window Window object /// \param grabbed true to enable, false to disable /// //////////////////////////////////////////////////////////// diff --git a/include/CSFML/Window/WindowBase.h b/include/CSFML/Window/WindowBase.h index 29f93de..b3f259d 100644 --- a/include/CSFML/Window/WindowBase.h +++ b/include/CSFML/Window/WindowBase.h @@ -287,7 +287,8 @@ CSFML_WINDOW_API void sfWindowBase_setMouseCursorVisible(sfWindowBase* windowBas /// won't have any effect (fullscreen windows always grab the /// cursor). /// -/// \param grabbed true to enable, false to disable +/// \param windowBase Window object +/// \param grabbed true to enable, false to disable /// //////////////////////////////////////////////////////////// CSFML_WINDOW_API void sfWindowBase_setMouseCursorGrabbed(sfWindowBase* windowBase, bool grabbed); diff --git a/src/CSFML/Graphics/RenderWindow.cpp b/src/CSFML/Graphics/RenderWindow.cpp index 680fcda..fabf151 100644 --- a/src/CSFML/Graphics/RenderWindow.cpp +++ b/src/CSFML/Graphics/RenderWindow.cpp @@ -254,11 +254,11 @@ void sfRenderWindow_setMouseCursorGrabbed(sfRenderWindow* renderWindow, bool gra //////////////////////////////////////////////////////////// -void sfRenderWindow_setMouseCursor(sfRenderWindow* window, const sfCursor* cursor) +void sfRenderWindow_setMouseCursor(sfRenderWindow* renderWindow, const sfCursor* cursor) { - assert(window); + assert(renderWindow); assert(cursor); - window->This.setMouseCursor(cursor->This); + renderWindow->This.setMouseCursor(cursor->This); }