From c4070364158b4249d6b0b52e9c00db5b1079e4db Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Tue, 10 Dec 2024 11:24:23 -0500
Subject: [PATCH] docs: enable Quick Reference wiki page
---
.wikiheaders-options | 4 ++++
include/SDL3_net/SDL_net.h | 6 +++++-
2 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/.wikiheaders-options b/.wikiheaders-options
index 8a9c668..fc72c79 100644
--- a/.wikiheaders-options
+++ b/.wikiheaders-options
@@ -16,3 +16,7 @@ warn_about_missing = 0
wikipreamble = (This function is part of SDL_net, a separate library from SDL.)
wikiheaderfiletext = Defined in [<SDL3_net/%fname%>](https://github.com/libsdl-org/SDL_net/blob/main/include/SDL3_net/%fname%)
manpageheaderfiletext = Defined in SDL3_net/%fname%
+quickrefenabled = 1
+quickreftitle = SDL3_net API Quick Reference
+quickrefurl = https://libsdl.org/
+quickrefdesc = The latest version of this document can be found at https://wiki.libsdl.org/SDL3_net/QuickReference
diff --git a/include/SDL3_net/SDL_net.h b/include/SDL3_net/SDL_net.h
index 98dbaaa..b9e99d6 100644
--- a/include/SDL3_net/SDL_net.h
+++ b/include/SDL3_net/SDL_net.h
@@ -19,8 +19,10 @@
3. This notice may not be removed or altered from any source distribution.
*/
+/* WIKI CATEGORY: SDLNet */
+
/**
- * \file SDL_net.h
+ * # CategorySDLNet
*
* Header file for SDL_net library
*
@@ -991,6 +993,8 @@ typedef struct SDLNet_Datagram
* you do not have to byteswap it into "network order," as the library will
* handle that for you.
*
+ * \param addr the local address to listen for connections on, or NULL to
+ * listen on all available local addresses.
* \param port the port on the local address to listen for connections on, or
* zero for the system to decide.
* \returns a new SDLNet_DatagramSocket, or NULL on error; call SDL_GetError()