From 3d93b07d5b741a5e2a3029b71ab12ca03fae680e Mon Sep 17 00:00:00 2001
From: Sylvain <[EMAIL REDACTED]>
Date: Sun, 12 Feb 2023 10:17:18 +0100
Subject: [PATCH] Documentation \param fixes
---
include/SDL3/SDL_hidapi.h | 2 +-
include/SDL3/SDL_joystick.h | 2 +-
include/SDL3/SDL_metal.h | 4 ++--
3 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/include/SDL3/SDL_hidapi.h b/include/SDL3/SDL_hidapi.h
index 53049700dc7d..94b6f7a2dd97 100644
--- a/include/SDL3/SDL_hidapi.h
+++ b/include/SDL3/SDL_hidapi.h
@@ -237,7 +237,7 @@ extern DECLSPEC SDL_hid_device * SDLCALL SDL_hid_open(unsigned short vendor_id,
* platform-specific path name can be used (eg: /dev/hidraw0 on Linux).
*
* \param path The path name of the device to open
- * \param bExclusive exclusive opening (windows only?FIXME)
+ * \param bExclusive Open device in exclusive mode (Windows only)
* \returns a pointer to a SDL_hid_device object on success or NULL on
* failure.
*
diff --git a/include/SDL3/SDL_joystick.h b/include/SDL3/SDL_joystick.h
index 71b5aeb9d449..44c7e7529b0a 100644
--- a/include/SDL3/SDL_joystick.h
+++ b/include/SDL3/SDL_joystick.h
@@ -309,7 +309,7 @@ extern DECLSPEC SDL_Joystick *SDLCALL SDL_GetJoystickFromPlayerIndex(int player_
/**
* Attach a new virtual joystick.
*
- * \param type Type of joystick
+ * \param type type of joystick
* \param naxes number of axes
* \param nbuttons number of buttons
* \param nhats number of hats
diff --git a/include/SDL3/SDL_metal.h b/include/SDL3/SDL_metal.h
index 79d0283d262e..80a8c50efbe3 100644
--- a/include/SDL3/SDL_metal.h
+++ b/include/SDL3/SDL_metal.h
@@ -74,7 +74,7 @@ extern DECLSPEC SDL_MetalView SDLCALL SDL_Metal_CreateView(SDL_Window * window);
* This should be called before SDL_DestroyWindow, if SDL_Metal_CreateView was
* called after SDL_CreateWindow.
*
- * \param view the view
+ * \param view the SDL_MetalView object
*
* \since This function is available since SDL 3.0.0.
*
@@ -85,7 +85,7 @@ extern DECLSPEC void SDLCALL SDL_Metal_DestroyView(SDL_MetalView view);
/**
* Get a pointer to the backing CAMetalLayer for the given view.
*
- * \param view the view
+ * \param view the SDL_MetalView object
* \returns a pointer
*
* \since This function is available since SDL 3.0.0.