wikiheaders: bridge wiki Category docs to the headers!

Did an initial cleanup on the headers and wrote a few pieces of documentation,
but this needs more work to fill out the documentation.
This commit is contained in:
Ryan C. Gordon
2024-05-16 10:44:37 -04:00
parent 558630d59c
commit 5e6d85b8f0
68 changed files with 617 additions and 388 deletions

View File

@@ -20,21 +20,21 @@
*/
/**
* \file SDL_haptic.h
* # CategoryHaptic
*
* The SDL haptic subsystem manages haptic (force feedback) devices.
* The SDL haptic subsystem manages haptic (force feedback) devices.
*
* The basic usage is as follows:
* The basic usage is as follows:
*
* - Initialize the subsystem (SDL_INIT_HAPTIC).
* - Open a haptic device.
* - SDL_OpenHaptic() to open from index.
* - SDL_OpenHapticFromJoystick() to open from an existing joystick.
* - Create an effect (SDL_HapticEffect).
* - Upload the effect with SDL_CreateHapticEffect().
* - Run the effect with SDL_RunHapticEffect().
* - (optional) Free the effect with SDL_DestroyHapticEffect().
* - Close the haptic device with SDL_CloseHaptic().
* - Initialize the subsystem (SDL_INIT_HAPTIC).
* - Open a haptic device.
* - SDL_OpenHaptic() to open from index.
* - SDL_OpenHapticFromJoystick() to open from an existing joystick.
* - Create an effect (SDL_HapticEffect).
* - Upload the effect with SDL_CreateHapticEffect().
* - Run the effect with SDL_RunHapticEffect().
* - (optional) Free the effect with SDL_DestroyHapticEffect().
* - Close the haptic device with SDL_CloseHaptic().
*
* Simple rumble example:
*
@@ -113,6 +113,7 @@
* Note that the SDL haptic subsystem is not thread-safe.
*/
#ifndef SDL_haptic_h_
#define SDL_haptic_h_