Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SDL_net.h: fix docs #98

Merged
merged 1 commit into from
May 6, 2024
Merged

SDL_net.h: fix docs #98

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions include/SDL3_net/SDL_net.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@ typedef struct SDLNet_StreamSocket SDLNet_StreamSocket; /**< a TCP socket. Reli
* handle that for you.
*
* \param address the address of the remote server to connect to
* \param the port on the remote server to connect to
* \param port the port on the remote server to connect to
* \returns a new SDLNet_StreamSocket, pending connection, or NULL on error;
* call SDL_GetError() for details.
*
Expand Down Expand Up @@ -516,7 +516,7 @@ extern DECLSPEC SDLNet_StreamSocket * SDLCALL SDLNet_CreateClient(SDLNet_Address
* SDLNet_GetConnectionStatus() from time to time until you get a non-zero
* result.
*
* \param address The SDLNet_Address object to wait on.
* \param sock The SDLNet_StreamSocket object to wait on.
* \param timeout Number of milliseconds to wait for resolution to complete.
* -1 to wait indefinitely, 0 to check once without waiting.
* \returns 1 if successfully connected, -1 if connection failed, 0 if still
Expand Down Expand Up @@ -569,8 +569,8 @@ typedef struct SDLNet_Server SDLNet_Server; /**< a listen socket, internally.
* you do not have to byteswap it into "network order," as the library will
* handle that for you.
*
* \param address the _local_ address to listen for connections on, or NULL.
* \param the port on the local address to listen for connections on
* \param addr the _local_ address to listen for connections on, or NULL.
* \param port the port on the local address to listen for connections on
* \returns a new SDLNet_StreamSocket, pending connection, or NULL on error;
* call SDL_GetError() for details.
*
Expand Down Expand Up @@ -1001,7 +1001,7 @@ typedef struct SDLNet_Datagram
* handle that for you.
*
* \param address the _local_ address to listen for connections on, or NULL.
* \param the port on the local address to listen for connections on, or zero
* \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()
* for details.
Expand Down Expand Up @@ -1049,6 +1049,8 @@ extern DECLSPEC SDLNet_DatagramSocket * SDLCALL SDLNet_CreateDatagramSocket(SDLN
* SDL_DestroyDatagramSocket().
*
* \param sock the datagram socket to send data through
* \param address the SDLNet_Address object address.
* \param port the address port.
* \param buf a pointer to the data to send as a single packet.
* \param buflen the size of the data to send, in bytes.
* \returns 0 if data sent or queued for transmission, -1 on failure; call
Expand Down Expand Up @@ -1098,8 +1100,7 @@ extern DECLSPEC int SDLCALL SDLNet_SendDatagram(SDLNet_DatagramSocket *sock, SDL
* SDL_DestroyDatagramSocket().
*
* \param sock the datagram socket to send data through
* \param buf a pointer to the data to send as a single packet.
* \param buflen the size of the data to send, in bytes.
* \param dgram a pointer to the datagram packet pointer.
* \returns 0 if data sent or queued for transmission, -1 on failure; call
* SDL_GetError() for details.
*
Expand Down
Loading