[Winmerge-svn] SF.net SVN: winmerge:[5629] trunk/Src/DiffItem.h

[<ki...@us...>]

Revision: 5629
          http://winmerge.svn.sourceforge.net/winmerge/?rev=5629&view=rev
Author:   kimmov
Date:     2008-07-17 16:42:46 +0000 (Thu, 17 Jul 2008)

Log Message:
-----------
Improve DIFFITEM description comment.

Modified Paths:
--------------
    trunk/Src/DiffItem.h

Modified: trunk/Src/DiffItem.h
===================================================================
--- trunk/Src/DiffItem.h	2008-07-17 16:38:57 UTC (rev 5628)
+++ trunk/Src/DiffItem.h	2008-07-17 16:42:46 UTC (rev 5629)
@@ -114,10 +114,15 @@
 };
 
 /**
- * @brief information about one diff (including files on both sides)
+ * @brief information about one file/folder item.
+ * This class holds information about one compared item in the folder compare.
+ * The item can be a file item or folder item. The item can have data from
+ * both compare sides (file/folder exists in both sides) or just from one
+ * side (file/folder exists only in other side).
  *
- * @note times in fileinfo's are seconds since January 1, 1970.
- * See Dirscan.cpp/fentry and Dirscan.cpp/LoadFiles()
+ * This class is for backend differences processing, presenting physical
+ * files and folders. This class is not for GUI data like selection or
+ * visibility statuses. So do not include any GUI-dependent data here. 
  */
 struct DIFFITEM : ListEntry
 {
@@ -131,9 +136,7 @@
 
 	static DIFFITEM emptyitem; /**< singleton to represent a diffitem that doesn't have any data */
 
-	DIFFITEM() : nidiffs(-1), nsdiffs(-1), customFlags1(0)
-	{
-	}
+	DIFFITEM() : nidiffs(-1), nsdiffs(-1), customFlags1(0) { }
 
 	bool isEmpty() const { return this == &emptyitem; }
 	String getLeftFilepath(const String &sLeftRoot) const;


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.