From 50e173e403ef8912e3d8ac3c7ab3e27e32243339 Mon Sep 17 00:00:00 2001 From: Jonny Date: Tue, 4 Feb 2020 23:37:28 +0000 Subject: [PATCH] Update documentation --- include/SFML/Network/Packet.hpp | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/include/SFML/Network/Packet.hpp b/include/SFML/Network/Packet.hpp index b4cf5d2e7..9728276c0 100644 --- a/include/SFML/Network/Packet.hpp +++ b/include/SFML/Network/Packet.hpp @@ -72,15 +72,17 @@ public: /// \param sizeInBytes Number of bytes to append /// /// \see clear - /// \see readCurrentReadPosition + /// \see getReadPosition /// //////////////////////////////////////////////////////////// void append(const void* data, std::size_t sizeInBytes); //////////////////////////////////////////////////////////// - /// \brief Get a current reading position + /// \brief Get the current reading position in the packet /// - /// \return Current position + /// The next read operation will read data from this position + /// + /// \return The byte offset of the current read position /// /// \see append ///