SDL/.wikiheaders-options

projectfullname = SDL
projectshortname = SDL
incsubdir = include/SDL3
wikisubdir =
readmesubdir = docs
apiprefixregex = (SDL_|SDLK_|KMOD_|AUDIO_)
mainincludefname = SDL3/SDL.h
versionfname = include/SDL3/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
bugreporturl = https://github.com/libsdl-org/sdlwiki/issues/new
warn_about_missing = 0
wikipreamble = (This is the documentation for SDL3, which is under heavy development and the API is changing! [SDL2](https://wiki.libsdl.org/SDL2/) is the current stable version!)
wikiheaderfiletext = Defined in [%fname%](https://github.com/libsdl-org/SDL/blob/main/include/SDL3/%fname%), but apps should _only_ `#include <SDL3/SDL.h>`!
manpageheaderfiletext = Defined in %fname%, but apps should only #include <SDL3/SDL.h>!
.wikiheader-options: Whoops, this isn't SDL_mixer. :) 2022-11-22 10:48:33 -07:00			`projectfullname = SDL`
			`projectshortname = SDL`
wikiheaders: We never updated the config when we moved to include/SDL3. :O 2023-01-24 17:42:03 -07:00			`incsubdir = include/SDL3`
wikiheaders.pl: changes to make this usable with external projects. 2022-06-15 21:25:36 -06:00			`wikisubdir =`
wikiheaders: Bridge README files in the docs directory to wiki. Fixes #6026. 2023-02-28 09:37:46 -07:00			`readmesubdir = docs`
wikiheaders.pl: changes to make this usable with external projects. 2022-06-15 21:25:36 -06:00			`apiprefixregex = (SDL_\|SDLK_\|KMOD_\|AUDIO_)`
sdlwiki: SDL3 advises users to include through 'SDL3/SDL.h' 2023-03-17 18:29:05 -06:00			`mainincludefname = SDL3/SDL.h`
sdlwiki: SDL_version.h moved to include/SDL3 2022-12-17 19:24:41 -07:00			`versionfname = include/SDL3/SDL_version.h`
wikiheaders.pl: changes to make this usable with external projects. 2022-06-15 21:25:36 -06:00			`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`
			`bugreporturl = https://github.com/libsdl-org/sdlwiki/issues/new`
			`warn_about_missing = 0`
wikiheaders: Fixed SDL2 wiki link. 2023-01-26 12:50:52 -07:00			`wikipreamble = (This is the documentation for SDL3, which is under heavy development and the API is changing! [SDL2](https://wiki.libsdl.org/SDL2/) is the current stable version!)`
wikiheaders.pl: Report a function's header file name. 2024-03-31 10:56:00 -06:00			wikiheaderfiletext = Defined in [%fname%](https://github.com/libsdl-org/SDL/blob/main/include/SDL3/%fname%), but apps should _only_ `#include <SDL3/SDL.h>`!
			`manpageheaderfiletext = Defined in %fname%, but apps should only #include <SDL3/SDL.h>!`