From bc88a43d97440860719e3ca92d603eafe505a806 Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Thu, 12 Dec 2024 10:49:36 -0500
Subject: [PATCH] .wikiheaders-option: Filled in quickref metadata.
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.
---
.wikiheaders-options | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/.wikiheaders-options b/.wikiheaders-options
index 3dc79ec133b07..bb0753139d786 100644
--- a/.wikiheaders-options
+++ b/.wikiheaders-options
@@ -22,3 +22,10 @@ manpageheaderfiletext = Defined in %fname%
# 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