From 40e8d0155e6d18e67dd97bc1d5c61f0a9fbc8afb Mon Sep 17 00:00:00 2001 From: "Ryan C. Gordon" Date: Sun, 9 Jun 2024 01:32:41 -0400 Subject: [PATCH] SDL_joystick.h: Add some notes to the category documentation. --- include/SDL3/SDL_joystick.h | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/include/SDL3/SDL_joystick.h b/include/SDL3/SDL_joystick.h index 96920d4c04..a9e0a4c39d 100644 --- a/include/SDL3/SDL_joystick.h +++ b/include/SDL3/SDL_joystick.h @@ -40,6 +40,14 @@ * The term SDL_JoystickGUID is a stable 128-bit identifier for a joystick * device that does not change over time, it identifies class of the device (a * X360 wired controller for example). This identifier is platform dependent. + * + * In order to use these functions, SDL_Init() must have been called + * with the SDL_INIT_JOYSTICK flag. This causes SDL to scan the system + * for joysticks, and load appropriate drivers. + * + * If you would like to receive joystick updates while the application + * is in the background, you should set the following hint before calling + * SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS */ #ifndef SDL_joystick_h_ @@ -59,18 +67,6 @@ extern "C" { #endif -/** - * \file SDL_joystick.h - * - * In order to use these functions, SDL_Init() must have been called - * with the SDL_INIT_JOYSTICK flag. This causes SDL to scan the system - * for joysticks, and load appropriate drivers. - * - * If you would like to receive joystick updates while the application - * is in the background, you should set the following hint before calling - * SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS - */ - #ifdef SDL_THREAD_SAFETY_ANALYSIS /* * This is not an exported symbol from SDL, this is only in the headers to