mirror of
https://github.com/SFML/CSFML.git
synced 2026-10-24 13:53:36 +02:00
Fix Doxygen warnings
This commit is contained in:
1 parent
63beea6043
commit
7f5807a6b5
12 files changed
+20
-6
No files matched your search
+1
-1
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
///
|
||||
|
||||
@@ -174,6 +174,7 @@ CSFML_AUDIO_API const char* sfSoundRecorder_getDevice(sfSoundRecorder* soundReco
|
||||
/// used for recording. Currently only 16-bit mono and
|
||||
/// 16-bit stereo are supported.
|
||||
///
|
||||
/// \param soundRecorder Sound recorder object
|
||||
/// \param channelCount Number of channels. Currently only
|
||||
/// mono (1) and stereo (2) are supported.
|
||||
///
|
||||
|
||||
@@ -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,6 +258,7 @@ CSFML_GRAPHICS_API void sfRenderWindow_setMouseCursorVisible(sfRenderWindow* ren
|
||||
/// won't have any effect (fullscreen windows always grab the
|
||||
/// cursor).
|
||||
///
|
||||
/// \param renderWindow Render window object
|
||||
/// \param grabbed true to enable, false to disable
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
@@ -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 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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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);
|
||||
|
||||
@@ -123,6 +123,7 @@ CSFML_GRAPHICS_API size_t sfVertexBuffer_getVertexCount(const sfVertexBuffer* ve
|
||||
/// array, passing invalid arguments will lead to undefined
|
||||
/// behavior.
|
||||
///
|
||||
/// \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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
|
||||
@@ -287,6 +287,7 @@ CSFML_WINDOW_API void sfWindowBase_setMouseCursorVisible(sfWindowBase* windowBas
|
||||
/// won't have any effect (fullscreen windows always grab the
|
||||
/// cursor).
|
||||
///
|
||||
/// \param windowBase Window object
|
||||
/// \param grabbed true to enable, false to disable
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
|
||||
@@ -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);
|
||||
}
|
||||
|
||||
|
||||
|
||||
Reference in new issue
Block a user