mirror of
https://github.com/libsdl-org/SDL.git
synced 2026-04-24 08:15:50 +00:00
bc88a43d97
This is still disabled because SDL2's documentation can be spotty at times, but it's better to have this stuff available in case we ever make some documentation improvements.
32 lines
2.0 KiB
Plaintext
32 lines
2.0 KiB
Plaintext
projectfullname = Simple Directmedia Layer
|
|
projectshortname = SDL
|
|
incsubdir = include
|
|
wikisubdir = SDL2
|
|
readmesubdir = docs
|
|
apiprefixregex = (SDL_|SDLK_|KMOD_|AUDIO_|[US]int\d+)
|
|
mainincludefname = SDL.h
|
|
versionfname = include/SDL_version.h
|
|
versionmajorregex = \A\#define\s+SDL_MAJOR_VERSION\s+(\d+)\Z
|
|
versionminorregex = \A\#define\s+SDL_MINOR_VERSION\s+(\d+)\Z
|
|
versionpatchregex = \A\#define\s+SDL_PATCHLEVEL\s+(\d+)\Z
|
|
selectheaderregex = \ASDL.*?\.h\Z
|
|
projecturl = https://libsdl.org/
|
|
wikiurl = https://wiki.libsdl.org/SDL2
|
|
bugreporturl = https://github.com/libsdl-org/sdlwiki/issues/new
|
|
warn_about_missing = 0
|
|
wikipreamble = (This is the legacy documentation for SDL2, the previous stable version; [SDL3](https://wiki.libsdl.org/SDL3/) is the current stable version.)
|
|
wikiheaderfiletext = Defined in [%fname%](https://github.com/libsdl-org/SDL/blob/SDL2/include/%fname%)
|
|
manpageheaderfiletext = Defined in %fname%
|
|
|
|
# All SDL_config_*.h headers are uncategorized, in case something slips in from them.
|
|
# All SDL_test_* headers become uncategorized, everything else just converts like SDL_audio.h -> Audio
|
|
# A handful of others we fix up in the header itself with /* WIKI CATEGORY: x */ comments.
|
|
headercategoryeval = s/\ASDL_config_.*?\.h\Z//; s/\ASDL_test_.*?\.h\Z//; s/\ASDL_?(.*?)\.h\Z/$1/; ucfirst();
|
|
|
|
quickrefenabled = 0 # !!! FIXME: maybe later, but there are probably documentation gaps to fix first.
|
|
quickrefcategoryorder = Init,Hints,Error,Version,Properties,Log,Video,Events,Keyboard,Mouse,Touch,Gesture,GameController,Joystick,Haptic,Audio,Timer,Render,LoadSO,Thread,Mutex,Atomic,Filesystem,RWOPS,Pixels,Surface,Blendmode,Rect,Clipboard,Messagebox,Vulkan,Metal,Platform,Power,Sensor,Bits,Endian,Assert,CPUInfo,Locale,System,Misc,GUID,Main,Stdinc
|
|
quickreftitle = SDL2 API Quick Reference
|
|
quickrefurl = https://libsdl.org/
|
|
quickrefdesc = The latest version of this document can be found at https://wiki.libsdl.org/SDL2/QuickReference
|
|
quickrefmacroregex = \A(SDL_Atomic...Ref|SDL_assert.*?|SDL_arraysize|SDL_Swap[BL]E\d\d|SDL_[a-z]+_cast|SDL_Load...)\Z
|