From: Kimmo Varis <kimmov@gmail.com>
Date: Tue, 16 Oct 2007 10:07:56 +0000 (+0000)
Subject: Comment additions and fixes.
X-Git-Tag: 2.16.5~3971
X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=9d42205d978db3b1e3c5de33632545bb0c5ad77e;p=winmerge-jp%2Fwinmerge-jp.git

Comment additions and fixes.
---

diff --git a/Src/files.cpp b/Src/files.cpp
index 9acc7388e..e7a4f47a7 100644
--- a/Src/files.cpp
+++ b/Src/files.cpp
@@ -19,7 +19,7 @@
  *
  * @brief Code file routines
  */
-// RCS ID line follows -- this is updated by CVS
+// ID line follows -- this is updated by SVN
 // $Id$
 
 #include "stdafx.h"
@@ -28,7 +28,9 @@
 #include "unicoder.h"
 
 /**
- * @brief Open file as memory-mapped file
+ * @brief Open file as memory-mapped file.
+ * @param [in,out] fileData Memory-mapped file's info.
+ * @return TRUE if opening succeeded, FALSE otherwise.
  */
 BOOL files_openFileMapped(MAPPEDFILEDATA *fileData)
 {
@@ -117,7 +119,11 @@ BOOL files_openFileMapped(MAPPEDFILEDATA *fileData)
 }
 
 /**
- * @brief Close memory-mapped file
+ * @brief Close memory-mapped file.
+ * @param [in, out] fileData Memory-mapped file's info.
+ * @param [in] newSize New size for the file.
+ * @param [in] flush Flush buffers before closing the file.
+ * @return TRUE if closing succeeded without errors, FALSE otherwise.
  */
 BOOL files_closeFileMapped(MAPPEDFILEDATA *fileData, DWORD newSize, BOOL flush)
 {
diff --git a/Src/files.h b/Src/files.h
index 2ea459d9a..b481d59f2 100644
--- a/Src/files.h
+++ b/Src/files.h
@@ -19,7 +19,7 @@
  *
  * @brief Declaration file for file routines
  */
-// RCS ID line follows -- this is updated by CVS
+// ID line follows -- this is updated by SVN
 // $Id$
 
 #ifndef _FILES_H_INCLUDED
@@ -55,6 +55,7 @@ public:
 	static DWORD Main(DWORD flr) { return flr & FRESULT_MAIN_MASK; }
 	static bool IsModifier(DWORD flr, DWORD modifier) { return !!(flr & modifier); }
 
+	/** @brief Return values for functions. */
 	enum
 	{
 		FRESULT_MAIN_MASK = 0xF,