From 2d8aeb70e8055d8bbb8e3088633083e187e2ac78 Mon Sep 17 00:00:00 2001 From: Jack Andersen Date: Fri, 19 Jun 2015 10:44:01 -1000 Subject: [PATCH] updated doxy comments --- include/Athena/FileReader.hpp | 6 +++--- include/Athena/MemoryReader.hpp | 9 ++++++--- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/include/Athena/FileReader.hpp b/include/Athena/FileReader.hpp index ce4a0a8..86a5aa0 100644 --- a/include/Athena/FileReader.hpp +++ b/include/Athena/FileReader.hpp @@ -50,9 +50,9 @@ public: bool readBool(); atVec3f readVec3f(); atVec4f readVec4f(); - std::string readString(atInt32 maxlen = -1); - std::wstring readWString(atInt32 maxLen = -1); - std::string readUnicode(atInt32 maxlen = -1); + std::string readString(atInt32 fixedLen = -1); + std::wstring readWString(atInt32 fixedLen = -1); + std::string readUnicode(atInt32 fixedLen = -1); protected: std::string m_filename; FILE* m_fileHandle; diff --git a/include/Athena/MemoryReader.hpp b/include/Athena/MemoryReader.hpp index 9206baf..1ab81c1 100644 --- a/include/Athena/MemoryReader.hpp +++ b/include/Athena/MemoryReader.hpp @@ -269,24 +269,27 @@ public: /*! \brief Reads a Unicode string and advances the position in the file * + * \param fixedLen If non-negative, this is a fixed-length string read * \return std::string The value at the current address * \throw IOException when address is out of range */ - std::string readUnicode(atInt32 maxlen = -1); + std::string readUnicode(atInt32 fixedLen = -1); /*! \brief Reads a string and advances the position in the file * + * \param fixedLen If non-negative, this is a fixed-length string read * \return std::string The value at the current address * \throw IOException when address is out of range */ - std::string readString(atInt32 maxlen = -1); + std::string readString(atInt32 fixedLen = -1); /*! \brief Reads a wstring and advances the position in the file * + * \param fixedLen If non-negative, this is a fixed-length string read * \return std::wstring The value at the current address * \throw IOException when address is out of range */ - std::wstring readWString(atInt32 maxlen = -1); + std::wstring readWString(atInt32 fixedLen = -1); void setProgressCallback(std::function cb); protected: