encounter
/
SDL
mirror of https://github.com/encounter/SDL.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed header documentation errors

This commit is contained in:
Sam Lantinga 2021-03-26 14:34:58 -07:00
parent 4a07c73b80
commit 40b0509ef6
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/SDL_joystick.h
View File

@ -275,7 +275,7 @@ extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index);
/** /**
* Get the SDL_Joystick associated with an instance id. * Get the SDL_Joystick associated with an instance id.
* *
* \param joyid the instance id to get the SDL_Joystick for * \param instance_id the instance id to get the SDL_Joystick for
* \returns an SDL_Joystick on success or NULL on failure; call SDL_GetError() * \returns an SDL_Joystick on success or NULL on failure; call SDL_GetError()
* for more information. * for more information.
* *

4
include/SDL_video.h
View File

@ -438,7 +438,7 @@ extern DECLSPEC int SDLCALL SDL_GetDisplayDPI(int displayIndex, float * ddpi, fl
/** /**
* Get the orientation of a display. * Get the orientation of a display.
* *
* \params displayIndex the index of the display to query * \param displayIndex the index of the display to query
* \returns The SDL_DisplayOrientation enum value of the display, or * \returns The SDL_DisplayOrientation enum value of the display, or
* `SDL_ORIENTATION_UNKNOWN` if it isn't available. * `SDL_ORIENTATION_UNKNOWN` if it isn't available.
* *
@ -1314,7 +1314,7 @@ extern DECLSPEC int SDLCALL SDL_SetWindowOpacity(SDL_Window * window, float opac
* This function also returns -1 if an invalid window was provided. * This function also returns -1 if an invalid window was provided.
* *
* \param window the window to get the current opacity value from * \param window the window to get the current opacity value from
* \param opacity the float filled in (0.0f - transparent, 1.0f - opaque) * \param out_opacity the float filled in (0.0f - transparent, 1.0f - opaque)
* \returns 0 on success or a negative error code on failure; call * \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *

2
include/SDL_vulkan.h
View File

@ -149,7 +149,7 @@ extern DECLSPEC void SDLCALL SDL_Vulkan_UnloadLibrary(void);
* should be retrieved (will be deprecated in a future release) * should be retrieved (will be deprecated in a future release)
* \param pCount A pointer to an unsigned int corresponding to the * \param pCount A pointer to an unsigned int corresponding to the
* number of extensions to be returned * number of extensions to be returned
* \param names NULL or a pointer to an array to be filled with required * \param pNames NULL or a pointer to an array to be filled with required
* Vulkan instance extensions * Vulkan instance extensions
* \returns SDL_TRUE on success, SDL_FALSE on error. * \returns SDL_TRUE on success, SDL_FALSE on error.
* *