From 94af24ee2d933fc26ef58c213649236a36dbf5e4 Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Fri, 17 Jun 2022 22:07:55 -0400
Subject: [PATCH] SDL_net.h: Fixed some missing documentation bits.
---
SDL_net.h | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/SDL_net.h b/SDL_net.h
index ffe1b90..a9e77de 100644
--- a/SDL_net.h
+++ b/SDL_net.h
@@ -592,6 +592,9 @@ extern DECLSPEC IPaddress * SDLCALL SDLNet_UDP_GetPeerAddress(UDPsocket sock, in
* reasonably send in a single packet, the better, as it will be more reliable
* and lower latency.
*
+ * \param sock the UDP socket to send packets on.
+ * \param packets an array of packets to send to the network.
+ * \param npackets the number of packets in the `packets` array.
* \returns the number of packets successfully sent from this machine.
*
* \since This function is available since SDL_net 2.0.0.
@@ -625,7 +628,9 @@ extern DECLSPEC int SDLCALL SDLNet_UDP_SendV(UDPsocket sock, UDPpacket **packets
* reasonably send in a single packet, the better, as it will be more reliable
* and lower latency.
*
- * This function returns 1 if the packet was sent, or 0 on error.
+ * \param sock the UDP socket to send packets on.
+ * \param packet a single packet to send to the network.
+ * \returns 1 if the packet was sent, or 0 on error.
*
* \since This function is available since SDL_net 2.0.0.
*/
@@ -951,6 +956,8 @@ extern DECLSPEC void SDLCALL SDLNet_SetError(const char *fmt, ...);
* failure was reported; the error string is only meaningful right after a
* public API reports a failure, and should be ignored otherwise.
*
+ * \returns the last set error message in UTF-8 encoding.
+ *
* \since This function is available since SDL_net 2.0.0.
*/
extern DECLSPEC const char * SDLCALL SDLNet_GetError(void);