.wikiheaders-options 2.0 KB

12345678910111213141516171819202122232425262728293031
  1. projectfullname = Simple Directmedia Layer
  2. projectshortname = SDL
  3. incsubdir = include
  4. wikisubdir = SDL2
  5. readmesubdir = docs
  6. apiprefixregex = (SDL_|SDLK_|KMOD_|AUDIO_|[US]int\d+)
  7. mainincludefname = SDL.h
  8. versionfname = include/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. versionpatchregex = \A\#define\s+SDL_PATCHLEVEL\s+(\d+)\Z
  12. selectheaderregex = \ASDL.*?\.h\Z
  13. projecturl = https://libsdl.org/
  14. wikiurl = https://wiki.libsdl.org/SDL2
  15. bugreporturl = https://github.com/libsdl-org/sdlwiki/issues/new
  16. warn_about_missing = 0
  17. #wikipreamble = (This is the legacy documentation for SDL2, the previous stable version; [SDL3](https://wiki.libsdl.org/SDL3/) is the current stable version.)
  18. wikiheaderfiletext = Defined in [%fname%](https://github.com/libsdl-org/SDL/blob/SDL2/include/%fname%)
  19. manpageheaderfiletext = Defined in %fname%
  20. # All SDL_config_*.h headers are uncategorized, in case something slips in from them.
  21. # All SDL_test_* headers become uncategorized, everything else just converts like SDL_audio.h -> Audio
  22. # A handful of others we fix up in the header itself with /* WIKI CATEGORY: x */ comments.
  23. headercategoryeval = s/\ASDL_config_.*?\.h\Z//; s/\ASDL_test_.*?\.h\Z//; s/\ASDL_?(.*?)\.h\Z/$1/; ucfirst();
  24. quickrefenabled = 0 # !!! FIXME: maybe later, but there are probably documentation gaps to fix first.
  25. 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
  26. quickreftitle = SDL2 API Quick Reference
  27. quickrefurl = https://libsdl.org/
  28. quickrefdesc = The latest version of this document can be found at https://wiki.libsdl.org/SDL2/QuickReference
  29. quickrefmacroregex = \A(SDL_Atomic...Ref|SDL_assert.*?|SDL_arraysize|SDL_Swap[BL]E\d\d|SDL_[a-z]+_cast|SDL_Load...)\Z