Document UniMemFile::ReadString() function parameters and return values

diff --git a/Src/Changes.txt b/Src/Changes.txt
index 84059aa..599b6a4 100644 (file)
--- a/Src/Changes.txt
+++ b/Src/Changes.txt
@@ -11,6 +11,8 @@ Add new items to top.
   Src/Languages/*: Merge*.rc
  Add Ed_K and David Maisonave to Contributors
   Docs/Users: Contributors.txt
+ Document UniMemFile::ReadString() function parameters and return values
+  Src/Common: UniFile.cpp
 
 2006-07-09 Kimmo
  Quiet warning about deprecated function for VS2003 and later

diff --git a/Src/Common/UniFile.cpp b/Src/Common/UniFile.cpp
index a89a717..89720a0 100644 (file)
--- a/Src/Common/UniFile.cpp
+++ b/Src/Common/UniFile.cpp
@@ -353,6 +353,9 @@ bool UniMemFile::ReadBom()
 
 /**
  * @brief Read one (DOS or UNIX or Mac) line. Do not include eol chars.
+ * @param [out] line Line read.
+ * @param [out] lossy TRUE if there were lossy encoding.
+ * @return TRUE if there is more lines to read, TRUE when last line is read.
  */
 BOOL UniMemFile::ReadString(CString & line, bool * lossy)
 {
@@ -390,7 +393,11 @@ static void RecordZero(UniFile::txtstats & txstats, int offset)
 }
 
 /**
- * @brief Read one (DOS or UNIX or Mac) line
+ * @brief Read one (DOS or UNIX or Mac) line.
+ * @param [out] line Line read.
+ * @param [out] eol EOL bytes read (if any).
+ * @param [out] lossy TRUE if there were lossy encoding.
+ * @return TRUE if there is more lines to read, TRUE when last line is read.
  */
 BOOL UniMemFile::ReadString(CString & line, CString & eol, bool * lossy)
 {