libAthena/athena
2
0
Fork 0
mirror of https://github.com/libAthena/athena.git synced 2025-12-09 05:27:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated doxy comments

Browse Source
This commit is contained in:
Jack Andersen
2015-06-19 10:44:01 -10:00
parent e641dbbe4b
commit 2d8aeb70e8
2 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
include/Athena/MemoryReader.hpp
View File

@@ -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<void(int)> cb);
protected: