From 66451e6596c2ab9fb2de04e5a39b6df6890b4045 Mon Sep 17 00:00:00 2001 From: Zachariah Brown Date: Tue, 19 Jan 2016 12:38:39 -0500 Subject: [PATCH] Corrected issues with documentation --- include/SFML/Graphics/CircleShape.h | 2 +- include/SFML/Graphics/ConvexShape.h | 2 +- include/SFML/Graphics/RectangleShape.h | 2 +- include/SFML/Graphics/Shape.h | 2 +- include/SFML/Graphics/Transform.h | 2 +- include/SFML/Network/Ftp.h | 6 +-- include/SFML/Network/IpAddress.h | 3 +- include/SFML/Network/TcpSocket.h | 4 +- include/SFML/Network/UdpSocket.h | 8 ++-- include/SFML/Window/VideoMode.h | 2 +- src/SFML/Network/Ftp.cpp | 14 +++---- src/SFML/Network/TcpSocket.cpp | 16 ++++---- src/SFML/Network/UdpSocket.cpp | 52 +++++++++++++------------- 13 files changed, 57 insertions(+), 58 deletions(-) diff --git a/include/SFML/Graphics/CircleShape.h b/include/SFML/Graphics/CircleShape.h index 764029d..ae3038e 100644 --- a/include/SFML/Graphics/CircleShape.h +++ b/include/SFML/Graphics/CircleShape.h @@ -58,7 +58,7 @@ CSFML_GRAPHICS_API sfCircleShape* sfCircleShape_copy(const sfCircleShape* shape) //////////////////////////////////////////////////////////// /// \brief Destroy an existing circle Shape /// -/// \param Shape Shape to delete +/// \param shape Shape to delete /// //////////////////////////////////////////////////////////// CSFML_GRAPHICS_API void sfCircleShape_destroy(sfCircleShape* shape); diff --git a/include/SFML/Graphics/ConvexShape.h b/include/SFML/Graphics/ConvexShape.h index 08438e7..4b62fa5 100644 --- a/include/SFML/Graphics/ConvexShape.h +++ b/include/SFML/Graphics/ConvexShape.h @@ -58,7 +58,7 @@ CSFML_GRAPHICS_API sfConvexShape* sfConvexShape_copy(const sfConvexShape* shape) //////////////////////////////////////////////////////////// /// \brief Destroy an existing convex Shape /// -/// \param Shape Shape to delete +/// \param shape Shape to delete /// //////////////////////////////////////////////////////////// CSFML_GRAPHICS_API void sfConvexShape_destroy(sfConvexShape* shape); diff --git a/include/SFML/Graphics/RectangleShape.h b/include/SFML/Graphics/RectangleShape.h index beca257..987a13c 100644 --- a/include/SFML/Graphics/RectangleShape.h +++ b/include/SFML/Graphics/RectangleShape.h @@ -58,7 +58,7 @@ CSFML_GRAPHICS_API sfRectangleShape* sfRectangleShape_copy(const sfRectangleShap //////////////////////////////////////////////////////////// /// \brief Destroy an existing rectangle shape /// -/// \param Shape Shape to delete +/// \param shape Shape to delete /// //////////////////////////////////////////////////////////// CSFML_GRAPHICS_API void sfRectangleShape_destroy(sfRectangleShape* shape); diff --git a/include/SFML/Graphics/Shape.h b/include/SFML/Graphics/Shape.h index 60c90aa..b8cdc25 100644 --- a/include/SFML/Graphics/Shape.h +++ b/include/SFML/Graphics/Shape.h @@ -57,7 +57,7 @@ CSFML_GRAPHICS_API sfShape* sfShape_create(sfShapeGetPointCountCallback getPoint //////////////////////////////////////////////////////////// /// \brief Destroy an existing shape /// -/// \param Shape Shape to delete +/// \param shape Shape to delete /// //////////////////////////////////////////////////////////// CSFML_GRAPHICS_API void sfShape_destroy(sfShape* shape); diff --git a/include/SFML/Graphics/Transform.h b/include/SFML/Graphics/Transform.h index 7237fbb..74f9a18 100644 --- a/include/SFML/Graphics/Transform.h +++ b/include/SFML/Graphics/Transform.h @@ -139,7 +139,7 @@ CSFML_GRAPHICS_API sfFloatRect sfTransform_transformRect(const sfTransform* tran /// equivalent to a matrix multiplication. /// /// \param transform Transform object -/// \param right Transform to combine to \a transform +/// \param other Transform to combine to \a transform /// //////////////////////////////////////////////////////////// CSFML_GRAPHICS_API void sfTransform_combine(sfTransform* transform, const sfTransform* other); diff --git a/include/SFML/Network/Ftp.h b/include/SFML/Network/Ftp.h index 82789e3..f15b840 100644 --- a/include/SFML/Network/Ftp.h +++ b/include/SFML/Network/Ftp.h @@ -332,7 +332,7 @@ CSFML_NETWORK_API sfFtpResponse* sfFtp_loginAnonymous(sfFtp* ftp); /// \return Server response to the request /// //////////////////////////////////////////////////////////// -CSFML_NETWORK_API sfFtpResponse* sfFtp_login(sfFtp* ftp, const char* userName, const char* password); +CSFML_NETWORK_API sfFtpResponse* sfFtp_login(sfFtp* ftp, const char* name, const char* password); //////////////////////////////////////////////////////////// /// \brief Close the connection with the server @@ -486,7 +486,7 @@ CSFML_NETWORK_API sfFtpResponse* sfFtp_deleteFile(sfFtp* ftp, const char* name); /// \return Server response to the request /// //////////////////////////////////////////////////////////// -CSFML_NETWORK_API sfFtpResponse* sfFtp_download(sfFtp* ftp, const char* distantFile, const char* destPath, sfFtpTransferMode mode); +CSFML_NETWORK_API sfFtpResponse* sfFtp_download(sfFtp* ftp, const char* remoteFile, const char* localPath, sfFtpTransferMode mode); //////////////////////////////////////////////////////////// /// \brief Upload a file to a FTP server @@ -504,7 +504,7 @@ CSFML_NETWORK_API sfFtpResponse* sfFtp_download(sfFtp* ftp, const char* distantF /// \return Server response to the request /// //////////////////////////////////////////////////////////// -CSFML_NETWORK_API sfFtpResponse* sfFtp_upload(sfFtp* ftp, const char* localFile, const char* destPath, sfFtpTransferMode mode); +CSFML_NETWORK_API sfFtpResponse* sfFtp_upload(sfFtp* ftp, const char* localFile, const char* remotePath, sfFtpTransferMode mode); //////////////////////////////////////////////////////////// /// \brief Send a command to the FTP server diff --git a/include/SFML/Network/IpAddress.h b/include/SFML/Network/IpAddress.h index 3295662..92d9dc5 100644 --- a/include/SFML/Network/IpAddress.h +++ b/include/SFML/Network/IpAddress.h @@ -114,8 +114,7 @@ CSFML_NETWORK_API sfIpAddress sfIpAddress_fromInteger(sfUint32 address); /// from a host name. /// /// \param address Address object -/// -/// \return String representation of the address +/// \param string String where the string representation will be stored /// //////////////////////////////////////////////////////////// CSFML_NETWORK_API void sfIpAddress_toString(sfIpAddress address, char* string); diff --git a/include/SFML/Network/TcpSocket.h b/include/SFML/Network/TcpSocket.h index 7f549a4..cd1b2cc 100644 --- a/include/SFML/Network/TcpSocket.h +++ b/include/SFML/Network/TcpSocket.h @@ -134,7 +134,7 @@ CSFML_NETWORK_API unsigned short sfTcpSocket_getRemotePort(const sfTcpSocket* so /// \return Status code /// //////////////////////////////////////////////////////////// -CSFML_NETWORK_API sfSocketStatus sfTcpSocket_connect(sfTcpSocket* socket, sfIpAddress host, unsigned short port, sfTime timeout); +CSFML_NETWORK_API sfSocketStatus sfTcpSocket_connect(sfTcpSocket* socket, sfIpAddress remoteAddress, unsigned short remotePort, sfTime timeout); //////////////////////////////////////////////////////////// /// \brief Disconnect a TCP socket from its remote peer @@ -194,7 +194,7 @@ CSFML_NETWORK_API sfSocketStatus sfTcpSocket_sendPartial(sfTcpSocket* socket, co /// \return Status code /// //////////////////////////////////////////////////////////// -CSFML_NETWORK_API sfSocketStatus sfTcpSocket_receive(sfTcpSocket* socket, void* data, size_t maxSize, size_t* sizeReceived); +CSFML_NETWORK_API sfSocketStatus sfTcpSocket_receive(sfTcpSocket* socket, void* data, size_t size, size_t* received); //////////////////////////////////////////////////////////// /// \brief Send a formatted packet of data to the remote peer of a TCP socket diff --git a/include/SFML/Network/UdpSocket.h b/include/SFML/Network/UdpSocket.h index a4ca69e..21dc2b5 100644 --- a/include/SFML/Network/UdpSocket.h +++ b/include/SFML/Network/UdpSocket.h @@ -137,7 +137,7 @@ CSFML_NETWORK_API void sfUdpSocket_unbind(sfUdpSocket* socket); /// \return Status code /// //////////////////////////////////////////////////////////// -CSFML_NETWORK_API sfSocketStatus sfUdpSocket_send(sfUdpSocket* socket, const void* data, size_t size, sfIpAddress address, unsigned short port); +CSFML_NETWORK_API sfSocketStatus sfUdpSocket_send(sfUdpSocket* socket, const void* data, size_t size, sfIpAddress remoteAddress, unsigned short remotePort); //////////////////////////////////////////////////////////// /// \brief Receive raw data from a remote peer with a UDP socket @@ -159,7 +159,7 @@ CSFML_NETWORK_API sfSocketStatus sfUdpSocket_send(sfUdpSocket* socket, const voi /// \return Status code /// //////////////////////////////////////////////////////////// -CSFML_NETWORK_API sfSocketStatus sfUdpSocket_receive(sfUdpSocket* socket, void* data, size_t maxSize, size_t* sizeReceived, sfIpAddress* address, unsigned short* port); +CSFML_NETWORK_API sfSocketStatus sfUdpSocket_receive(sfUdpSocket* socket, void* data, size_t size, size_t* received, sfIpAddress* remoteAddress, unsigned short* remotePort); //////////////////////////////////////////////////////////// /// \brief Send a formatted packet of data to a remote peer with a UDP socket @@ -176,7 +176,7 @@ CSFML_NETWORK_API sfSocketStatus sfUdpSocket_receive(sfUdpSocket* socket, void* /// \return Status code /// //////////////////////////////////////////////////////////// -CSFML_NETWORK_API sfSocketStatus sfUdpSocket_sendPacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress address, unsigned short port); +CSFML_NETWORK_API sfSocketStatus sfUdpSocket_sendPacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress remoteAddress, unsigned short remotePort); //////////////////////////////////////////////////////////// /// \brief Receive a formatted packet of data from a remote peer with a UDP socket @@ -191,7 +191,7 @@ CSFML_NETWORK_API sfSocketStatus sfUdpSocket_sendPacket(sfUdpSocket* socket, sfP /// \return Status code /// //////////////////////////////////////////////////////////// -CSFML_NETWORK_API sfSocketStatus sfUdpSocket_receivePacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress* address, unsigned short* port); +CSFML_NETWORK_API sfSocketStatus sfUdpSocket_receivePacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress* remoteAddress, unsigned short* remotePort); //////////////////////////////////////////////////////////// /// \brief Return the maximum number of bytes that can be diff --git a/include/SFML/Window/VideoMode.h b/include/SFML/Window/VideoMode.h index 71b8843..90f9b8e 100644 --- a/include/SFML/Window/VideoMode.h +++ b/include/SFML/Window/VideoMode.h @@ -70,7 +70,7 @@ CSFML_WINDOW_API sfVideoMode sfVideoMode_getDesktopMode(void); /// \return Pointer to an array containing all the supported fullscreen modes /// //////////////////////////////////////////////////////////// -CSFML_WINDOW_API const sfVideoMode* sfVideoMode_getFullscreenModes(size_t* Count); +CSFML_WINDOW_API const sfVideoMode* sfVideoMode_getFullscreenModes(size_t* count); //////////////////////////////////////////////////////////// /// \brief Tell whether or not a video mode is valid diff --git a/src/SFML/Network/Ftp.cpp b/src/SFML/Network/Ftp.cpp index 474b3f5..5916668 100644 --- a/src/SFML/Network/Ftp.cpp +++ b/src/SFML/Network/Ftp.cpp @@ -189,11 +189,11 @@ sfFtpResponse* sfFtp_loginAnonymous(sfFtp* ftp) //////////////////////////////////////////////////////////// -sfFtpResponse* sfFtp_login(sfFtp* ftp, const char* userName, const char* password) +sfFtpResponse* sfFtp_login(sfFtp* ftp, const char* name, const char* password) { CSFML_CHECK_RETURN(ftp, NULL); - return new sfFtpResponse(ftp->This.login(userName ? userName : "", password ? password : "")); + return new sfFtpResponse(ftp->This.login(name ? name : "", password ? password : "")); } @@ -288,23 +288,23 @@ sfFtpResponse* sfFtp_deleteFile(sfFtp* ftp, const char* name) //////////////////////////////////////////////////////////// -sfFtpResponse* sfFtp_download(sfFtp* ftp, const char* distantFile, const char* destPath, sfFtpTransferMode mode) +sfFtpResponse* sfFtp_download(sfFtp* ftp, const char* remoteFile, const char* localPath, sfFtpTransferMode mode) { CSFML_CHECK_RETURN(ftp, NULL); - return new sfFtpResponse(ftp->This.download(distantFile ? distantFile : "", - destPath ? destPath : "", + return new sfFtpResponse(ftp->This.download(remoteFile ? remoteFile : "", + localPath ? localPath : "", static_cast(mode))); } //////////////////////////////////////////////////////////// -sfFtpResponse* sfFtp_upload(sfFtp* ftp, const char* localFile, const char* destPath, sfFtpTransferMode mode) +sfFtpResponse* sfFtp_upload(sfFtp* ftp, const char* localFile, const char* remotePath, sfFtpTransferMode mode) { CSFML_CHECK_RETURN(ftp, NULL); return new sfFtpResponse(ftp->This.upload(localFile ? localFile : "", - destPath ? destPath : "", + remotePath ? remotePath : "", static_cast(mode))); } diff --git a/src/SFML/Network/TcpSocket.cpp b/src/SFML/Network/TcpSocket.cpp index ed1a674..1d4e015 100644 --- a/src/SFML/Network/TcpSocket.cpp +++ b/src/SFML/Network/TcpSocket.cpp @@ -89,13 +89,13 @@ unsigned short sfTcpSocket_getRemotePort(const sfTcpSocket* socket) //////////////////////////////////////////////////////////// -sfSocketStatus sfTcpSocket_connect(sfTcpSocket* socket, sfIpAddress host, unsigned short port, sfTime timeout) +sfSocketStatus sfTcpSocket_connect(sfTcpSocket* socket, sfIpAddress remoteAddress, unsigned short remotePort, sfTime timeout) { - sf::IpAddress address(host.address); + sf::IpAddress address(remoteAddress.address); CSFML_CHECK_RETURN(socket, sfSocketError); - return static_cast(socket->This.connect(address, port, sf::microseconds(timeout.microseconds))); + return static_cast(socket->This.connect(address, remotePort, sf::microseconds(timeout.microseconds))); } @@ -125,18 +125,18 @@ sfSocketStatus sfTcpSocket_sendPartial(sfTcpSocket* socket, const void* data, si //////////////////////////////////////////////////////////// -sfSocketStatus sfTcpSocket_receive(sfTcpSocket* socket, void* data, size_t maxSize, size_t* sizeReceived) +sfSocketStatus sfTcpSocket_receive(sfTcpSocket* socket, void* data, size_t size, size_t* received) { CSFML_CHECK_RETURN(socket, sfSocketError); - if (sizeReceived) + if (received) { - return static_cast(socket->This.receive(data, maxSize, *sizeReceived)); + return static_cast(socket->This.receive(data, size, *received)); } else { - std::size_t size = 0; - return static_cast(socket->This.receive(data, maxSize, size)); + std::size_t tempReceived = 0; + return static_cast(socket->This.receive(data, size, tempReceived)); } } diff --git a/src/SFML/Network/UdpSocket.cpp b/src/SFML/Network/UdpSocket.cpp index cfd545a..9e181aa 100644 --- a/src/SFML/Network/UdpSocket.cpp +++ b/src/SFML/Network/UdpSocket.cpp @@ -84,74 +84,74 @@ void sfUdpSocket_unbind(sfUdpSocket* socket) //////////////////////////////////////////////////////////// -sfSocketStatus sfUdpSocket_send(sfUdpSocket* socket, const void* data, size_t size, sfIpAddress address, unsigned short port) +sfSocketStatus sfUdpSocket_send(sfUdpSocket* socket, const void* data, size_t size, sfIpAddress remoteAddress, unsigned short remotePort) { CSFML_CHECK_RETURN(socket, sfSocketError); // Convert the address - sf::IpAddress receiver(address.address); + sf::IpAddress address(remoteAddress.address); - return static_cast(socket->This.send(data, size, receiver, port)); + return static_cast(socket->This.send(data, size, address, remotePort)); } //////////////////////////////////////////////////////////// -sfSocketStatus sfUdpSocket_receive(sfUdpSocket* socket, void* data, size_t maxSize, size_t* sizeReceived, sfIpAddress* address, unsigned short* port) +sfSocketStatus sfUdpSocket_receive(sfUdpSocket* socket, void* data, size_t size, size_t* received, sfIpAddress* remoteAddress, unsigned short* remotePort) { CSFML_CHECK_RETURN(socket, sfSocketError); - // Call SFML internal function - sf::IpAddress sender; - unsigned short senderPort; - std::size_t received; + sf::IpAddress address; + unsigned short port; + std::size_t sizeReceived; - sf::Socket::Status status = socket->This.receive(data, maxSize, received, sender, senderPort); + sf::Socket::Status status = socket->This.receive(data, size, sizeReceived, address, port); if (status != sf::Socket::Done) return static_cast(status); - if (sizeReceived) - *sizeReceived = received; + if (received) + *received = sizeReceived; - if (address) - strncpy(address->address, sender.toString().c_str(), 16); + if (remoteAddress) + strncpy(remoteAddress->address, address.toString().c_str(), 16); - if (port) - *port = senderPort; + if (remotePort) + *remotePort = port; return sfSocketDone; } //////////////////////////////////////////////////////////// -sfSocketStatus sfUdpSocket_sendPacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress address, unsigned short port) +sfSocketStatus sfUdpSocket_sendPacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress remoteAddress, unsigned short remotePort) { CSFML_CHECK_RETURN(socket, sfSocketError); CSFML_CHECK_RETURN(packet, sfSocketError); // Convert the address - sf::IpAddress receiver(address.address); + sf::IpAddress address(remoteAddress.address); - return static_cast(socket->This.send(packet->This, receiver, port)); + return static_cast(socket->This.send(packet->This, address, remotePort)); } //////////////////////////////////////////////////////////// -sfSocketStatus sfUdpSocket_receivePacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress* address, unsigned short* port) +sfSocketStatus sfUdpSocket_receivePacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress* remoteAddress, unsigned short* remotePort) { CSFML_CHECK_RETURN(socket, sfSocketError); CSFML_CHECK_RETURN(packet, sfSocketError); - sf::IpAddress sender; - unsigned short senderPort; - sf::Socket::Status status = socket->This.receive(packet->This, sender, senderPort); + sf::IpAddress address; + unsigned short port; + + sf::Socket::Status status = socket->This.receive(packet->This, address, port); if (status != sf::Socket::Done) return static_cast(status); - if (address) - strncpy(address->address, sender.toString().c_str(), 16); + if (remoteAddress) + strncpy(remoteAddress->address, address.toString().c_str(), 16); - if (port) - *port = senderPort; + if (remotePort) + *remotePort = port; return sfSocketDone; }