.wikiheaders-options 1.9 KB

123456789101112131415161718192021222324252627282930
  1. projectfullname = Simple Directmedia Layer
  2. projectshortname = SDL
  3. incsubdir = include/SDL3
  4. wikisubdir =
  5. readmesubdir = docs
  6. apiprefixregex = (SDL_|SDLK_|[US]int\d+)
  7. mainincludefname = SDL3/SDL.h
  8. versionfname = include/SDL3/SDL_version.h
  9. versionmajorregex = \A\#define\s+SDL_MAJOR_VERSION\s+(\d+)\Z
  10. versionminorregex = \A\#define\s+SDL_MINOR_VERSION\s+(\d+)\Z
  11. versionmicroregex = \A\#define\s+SDL_MICRO_VERSION\s+(\d+)\Z
  12. selectheaderregex = \ASDL.*?\.h\Z
  13. projecturl = https://libsdl.org/
  14. wikiurl = https://wiki.libsdl.org
  15. bugreporturl = https://github.com/libsdl-org/sdlwiki/issues/new
  16. warn_about_missing = 0
  17. wikipreamble = (This is the documentation for SDL3, which is the current stable version. [SDL2](https://wiki.libsdl.org/SDL2/) was the previous version!)
  18. wikiheaderfiletext = Defined in [<SDL3/%fname%>](https://github.com/libsdl-org/SDL/blob/main/include/SDL3/%fname%)
  19. manpageheaderfiletext = Defined in SDL3/%fname%
  20. # All SDL_test_* headers become undefined categories, everything else just converts like SDL_audio.h -> Audio
  21. # A handful of others we fix up in the header itself with /* WIKI CATEGORY: x */ comments.
  22. headercategoryeval = s/\ASDL_test_?.*?\.h\Z//; s/\ASDL_?(.*?)\.h\Z/$1/; ucfirst();
  23. quickrefenabled = 1
  24. quickrefcategoryorder = Init,Hints,Error,Version,Properties,Log,Video,Events,Keyboard,Mouse,Touch,Gamepad,Joystick,Haptic,Audio,Time,Timer,Render,SharedObject,Thread,Mutex,Atomic,Filesystem,IOStream,AsyncIO,Storage,Pixels,Surface,Blendmode,Rect,Camera,Clipboard,Dialog,GPU,Messagebox,Vulkan,Metal,Platform,Power,Sensor,Process,Bits,Endian,Assert,CPUInfo,Intrinsics,Locale,System,Misc,GUID,Main,Stdinc
  25. quickreftitle = SDL3 API Quick Reference
  26. quickrefurl = https://libsdl.org/
  27. quickrefdesc = The latest version of this document can be found at https://wiki.libsdl.org/SDL3/QuickReference
  28. quickrefmacroregex = \A(SDL_PLATFORM_.*|SDL_.*_INTRINSICS|SDL_Atomic...Ref|SDL_assert.*?|SDL_COMPILE_TIME_ASSERT|SDL_arraysize|SDL_Swap[BL]E\d\d|SDL_[a-z]+_cast)\Z