Sync SDL2_net header -> wiki

libsdl-org · May 9, 2024 · 814d05b · 814d05b
1 parent c88121b
commit 814d05b
Show file tree

Hide file tree

Showing 44 changed files with 509 additions and 103 deletions.
diff --git a/SDL2_net/SDLNet_AddSocket.md b/SDL2_net/SDLNet_AddSocket.md
@@ -3,6 +3,10 @@
 
 Add a socket to a socket set, to be checked for available data.
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -40,15 +44,15 @@ number of sockets currently contained in the set.
 
 This function is available since SDL_net 2.0.0.
 
-## Related Functions
+## See Also
 
-* [SDLNet_TCP_AddSocket](SDLNet_TCP_AddSocket)
-* [SDLNet_UDP_AddSocket](SDLNet_UDP_AddSocket)
-* [SDLNet_DelSocket](SDLNet_DelSocket)
-* [SDLNet_TCP_DelSocket](SDLNet_TCP_DelSocket)
-* [SDLNet_UDP_DelSocket](SDLNet_UDP_DelSocket)
-* [SDLNet_CheckSockets](SDLNet_CheckSockets)
+- [SDLNet_TCP_AddSocket](SDLNet_TCP_AddSocket)
+- [SDLNet_UDP_AddSocket](SDLNet_UDP_AddSocket)
+- [SDLNet_DelSocket](SDLNet_DelSocket)
+- [SDLNet_TCP_DelSocket](SDLNet_TCP_DelSocket)
+- [SDLNet_UDP_DelSocket](SDLNet_UDP_DelSocket)
+- [SDLNet_CheckSockets](SDLNet_CheckSockets)
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_AllocPacket.md b/SDL2_net/SDLNet_AllocPacket.md
@@ -3,6 +3,10 @@
 
 Allocate a single UDP packet.
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -36,12 +40,12 @@ You can allocate multiple packets at once with
 
 This function is available since SDL_net 2.0.0.
 
-## Related Functions
+## See Also
 
-* [SDLNet_ResizePacket](SDLNet_ResizePacket)
-* [SDLNet_FreePacket](SDLNet_FreePacket)
-* [SDLNet_AllocPacketV](SDLNet_AllocPacketV)
+- [SDLNet_ResizePacket](SDLNet_ResizePacket)
+- [SDLNet_FreePacket](SDLNet_FreePacket)
+- [SDLNet_AllocPacketV](SDLNet_AllocPacketV)
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_AllocPacketV.md b/SDL2_net/SDLNet_AllocPacketV.md
@@ -3,6 +3,10 @@
 
 Allocate a UDP packet vector (array of packets).
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -34,10 +38,10 @@ packets from this function with [SDLNet_FreePacket](SDLNet_FreePacket).
 
 This function is available since SDL_net 2.0.0.
 
-## Related Functions
+## See Also
 
-* [SDLNet_FreePacketV](SDLNet_FreePacketV)
+- [SDLNet_FreePacketV](SDLNet_FreePacketV)
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_AllocSocketSet.md b/SDL2_net/SDLNet_AllocSocketSet.md
@@ -3,6 +3,10 @@
 
 Allocate a socket set for use with [SDLNet_CheckSockets](SDLNet_CheckSockets)().
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -35,10 +39,10 @@ When done with a socket set, you can free it with
 
 This function is available since SDL_net 2.0.0.
 
-## Related Functions
+## See Also
 
-* [SDLNet_FreeSocketSet](SDLNet_FreeSocketSet)
+- [SDLNet_FreeSocketSet](SDLNet_FreeSocketSet)
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_CheckSockets.md b/SDL2_net/SDLNet_CheckSockets.md
@@ -3,6 +3,10 @@
 
 Check a socket set for data availability.
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -34,5 +38,5 @@ in milliseconds has elapsed, whichever occurs first.
 This function is available since SDL_net 2.0.0.
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_DelSocket.md b/SDL2_net/SDLNet_DelSocket.md
@@ -3,6 +3,10 @@
 
 Remove a socket from a set of sockets to be checked for available data.
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -39,15 +43,15 @@ nothing is removed from the set.
 
 This function is available since SDL_net 2.0.0.
 
-## Related Functions
+## See Also
 
-* [SDLNet_TCP_DelSocket](SDLNet_TCP_DelSocket)
-* [SDLNet_UDP_DelSocket](SDLNet_UDP_DelSocket)
-* [SDLNet_AddSocket](SDLNet_AddSocket)
-* [SDLNet_TCP_AddSocket](SDLNet_TCP_AddSocket)
-* [SDLNet_UDP_AddSocket](SDLNet_UDP_AddSocket)
-* [SDLNet_CheckSockets](SDLNet_CheckSockets)
+- [SDLNet_TCP_DelSocket](SDLNet_TCP_DelSocket)
+- [SDLNet_UDP_DelSocket](SDLNet_UDP_DelSocket)
+- [SDLNet_AddSocket](SDLNet_AddSocket)
+- [SDLNet_TCP_AddSocket](SDLNet_TCP_AddSocket)
+- [SDLNet_UDP_AddSocket](SDLNet_UDP_AddSocket)
+- [SDLNet_CheckSockets](SDLNet_CheckSockets)
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_FreePacket.md b/SDL2_net/SDLNet_FreePacket.md
@@ -3,6 +3,10 @@
 
 Dispose of a UDP packet.
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -25,11 +29,11 @@ completes, the packet's pointer is invalid and should not be used anymore.
 
 This function is available since SDL_net 2.0.0.
 
-## Related Functions
+## See Also
 
-* [SDLNet_AllocPacket](SDLNet_AllocPacket)
-* [SDLNet_ResizePacket](SDLNet_ResizePacket)
+- [SDLNet_AllocPacket](SDLNet_AllocPacket)
+- [SDLNet_ResizePacket](SDLNet_ResizePacket)
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_FreePacketV.md b/SDL2_net/SDLNet_FreePacketV.md
@@ -3,6 +3,10 @@
 
 Free a UDP packet vector (array of packets).
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -31,10 +35,10 @@ than [SDLNet_AllocPacketV](SDLNet_AllocPacketV)().
 
 This function is available since SDL_net 2.0.0.
 
-## Related Functions
+## See Also
 
-* [SDLNet_AllocPacketV](SDLNet_AllocPacketV)
+- [SDLNet_AllocPacketV](SDLNet_AllocPacketV)
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_FreeSocketSet.md b/SDL2_net/SDLNet_FreeSocketSet.md
@@ -3,6 +3,10 @@
 
 Free a set of sockets allocated by [SDLNet_AllocSocketSet](SDLNet_AllocSocketSet)().
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -30,5 +34,5 @@ which would still (at some future point) need to be closed with
 This function is available since SDL_net 2.0.0.
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_GetError.md b/SDL2_net/SDLNet_GetError.md
@@ -3,6 +3,10 @@
 
 Get the latest error message from SDL_net.
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -26,5 +30,5 @@ public API reports a failure, and should be ignored otherwise.
 This function is available since SDL_net 2.0.0.
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_GetLocalAddresses.md b/SDL2_net/SDLNet_GetLocalAddresses.md
@@ -3,6 +3,10 @@
 
 Get the addresses of network interfaces on this system.
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -26,5 +30,5 @@ Returns the number of addresses saved in `addresses`
 This function is available since SDL_net 2.0.0.
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_Init.md b/SDL2_net/SDLNet_Init.md
@@ -3,6 +3,10 @@
 
 Initialize SDL_net.
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -33,5 +37,5 @@ must pair your init and quit calls.
 This function is available since SDL_net 2.0.0.
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_Linked_Version.md b/SDL2_net/SDLNet_Linked_Version.md
@@ -3,6 +3,10 @@
 
 Query the version of SDL_net that the program is linked against.
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -27,5 +31,5 @@ This returns static internal data; do not free or modify it!
 This function is available since SDL_net 2.0.0.
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_Quit.md b/SDL2_net/SDLNet_Quit.md
@@ -3,6 +3,10 @@
 
 Deinitialize SDL_net.
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -24,5 +28,5 @@ Once you have as many quit calls as you have had successful calls to
 This function is available since SDL_net 2.0.0.
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_ResizePacket.md b/SDL2_net/SDLNet_ResizePacket.md
@@ -3,6 +3,10 @@
 
 Reallocate a UDP packet's payload space.
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -43,11 +47,11 @@ not realloc the existing data.
 
 This function is available since SDL_net 2.0.0.
 
-## Related Functions
+## See Also
 
-* [SDLNet_AllocPacket](SDLNet_AllocPacket)
-* [SDLNet_FreePacket](SDLNet_FreePacket)
+- [SDLNet_AllocPacket](SDLNet_AllocPacket)
+- [SDLNet_FreePacket](SDLNet_FreePacket)
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_ResolveHost.md b/SDL2_net/SDLNet_ResolveHost.md
@@ -3,6 +3,10 @@
 
 Resolve a host name and port to an IP address in network form.
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -34,5 +38,5 @@ will be INADDR_NONE, and the function will return -1.
 This function is available since SDL_net 2.0.0.
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
diff --git a/SDL2_net/SDLNet_ResolveIP.md b/SDL2_net/SDLNet_ResolveIP.md
@@ -3,6 +3,10 @@
 
 Resolve an IP address to a host name in canonical form.
 
+## Header File
+
+Defined in SDL_net.h
+
 ## Syntax
 
 ```c
@@ -28,5 +32,5 @@ pointer to a static buffer containing the hostname is returned.
 This function is available since SDL_net 2.0.0.
 
 ----
-[CategoryAPI](CategoryAPI)
+[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)