[ros-diffs] [martinf] 23539: some commentary changes

Author: martinf
Date: Thu Aug 10 01:27:05 2006
New Revision: 23539

URL: http://svn.reactos.org/svn/reactos?rev=23539&view=rev
Log:
some commentary changes

Modified:
    trunk/reactos/base/shell/explorer/desktop/desktop.h
    trunk/reactos/base/shell/explorer/explorer-bn.rc
    trunk/reactos/base/shell/explorer/shell/mainframe.cpp
    trunk/reactos/base/shell/explorer/utility/xmlstorage.cpp
    trunk/reactos/base/shell/explorer/utility/xmlstorage.h
    trunk/reactos/base/shell/explorer/utility/xs-native.cpp

Modified: trunk/reactos/base/shell/explorer/desktop/desktop.h
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/base/shell/explorer/deskto…
==============================================================================
--- trunk/reactos/base/shell/explorer/desktop/desktop.h (original)
+++ trunk/reactos/base/shell/explorer/desktop/desktop.h Thu Aug 10 01:27:05 2006
@@ -31,7 +31,7 @@
 #define	PM_DISPLAY_VERSION		(WM_APP+0x24)
 
 
- /// subclassed Background window behind the visible desktop window
+ /// subclassed background window behind the visible desktop window
 struct BackgroundWindow : public SubclassedWindow
 {
 	typedef SubclassedWindow super;

Modified: trunk/reactos/base/shell/explorer/explorer-bn.rc
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/base/shell/explorer/explor…
==============================================================================
--- trunk/reactos/base/shell/explorer/explorer-bn.rc (original)
+++ trunk/reactos/base/shell/explorer/explorer-bn.rc Thu Aug 10 01:27:05 2006
@@ -13,7 +13,7 @@
 #undef APSTUDIO_READONLY_SYMBOLS
 
 /////////////////////////////////////////////////////////////////////////////
-// English (U.S.) resources
+// Bengali resources
 
 #if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENU)
 #ifdef _WIN32
@@ -379,7 +379,7 @@
     IDS_TASKBAR             "Kvh©Kvix `Û"
 END
 
-#endif    // English (U.S.) resources
+#endif    // Bengali resources
 /////////////////////////////////////////////////////////////////////////////
 
 

Modified: trunk/reactos/base/shell/explorer/shell/mainframe.cpp
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/base/shell/explorer/shell/…
==============================================================================
--- trunk/reactos/base/shell/explorer/shell/mainframe.cpp (original)
+++ trunk/reactos/base/shell/explorer/shell/mainframe.cpp Thu Aug 10 01:27:05 2006
@@ -1285,7 +1285,7 @@
 	_tsplitpath_s(path, drv1, COUNTOF(drv1), NULL, 0, NULL, 0, NULL, 0);
 
 	 // search for a already open window for the same drive
-	for(child_wnd=::GetNextWindow(_hmdiclient,GW_CHILD); child_wnd;
child_wnd=::GetNextWindow(child_wnd, GW_HWNDNEXT)) {
+	for(child_wnd=GetNextWindow(_hmdiclient,GW_CHILD); child_wnd;
child_wnd=GetNextWindow(child_wnd, GW_HWNDNEXT)) {
 		FileChildWindow* child = (FileChildWindow*) SendMessage(child_wnd, PM_GET_FILEWND_PTR,
0, 0);
 
 		if (child) {
@@ -1310,7 +1310,7 @@
 	HWND child_wnd;
 
 	 // search for a already open window of the given file system name
-	for(child_wnd=::GetNextWindow(_hmdiclient,GW_CHILD); child_wnd;
child_wnd=::GetNextWindow(child_wnd, GW_HWNDNEXT)) {
+	for(child_wnd=GetNextWindow(_hmdiclient,GW_CHILD); child_wnd;
child_wnd=GetNextWindow(child_wnd, GW_HWNDNEXT)) {
 		FileChildWindow* child = (FileChildWindow*) SendMessage(child_wnd, PM_GET_FILEWND_PTR,
0, 0);
 
 		if (child) {

Modified: trunk/reactos/base/shell/explorer/utility/xmlstorage.cpp
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/base/shell/explorer/utilit…
==============================================================================
--- trunk/reactos/base/shell/explorer/utility/xmlstorage.cpp (original)
+++ trunk/reactos/base/shell/explorer/utility/xmlstorage.cpp Thu Aug 10 01:27:05 2006
@@ -1,11 +1,12 @@
 
  //
- // XML storage classes
- //
- // xmlstorage.cpp
+ // XML storage classes Version 1.1
  //
  // Copyright (c) 2004, 2005, 2006 Martin Fuchs <martin-fuchs(a)gmx.net>
  //
+
+ /// \file xmlstorage.cpp
+ /// XMLStorage implementation file
 
 
 /*
@@ -593,7 +594,6 @@
 }
 
 
-
 void XMLFormat::print_header(std::ostream& out, bool lf) const
 {
 	out << "<?xml version=\"" << _version <<
"\" encoding=\"" << _encoding << "\"";

Modified: trunk/reactos/base/shell/explorer/utility/xmlstorage.h
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/base/shell/explorer/utilit…
==============================================================================
--- trunk/reactos/base/shell/explorer/utility/xmlstorage.h (original)
+++ trunk/reactos/base/shell/explorer/utility/xmlstorage.h Thu Aug 10 01:27:05 2006
@@ -1,11 +1,12 @@
 
  //
- // XML storage classes
- //
- // xmlstorage.h
+ // XML storage classes Version 1.1
  //
  // Copyright (c) 2004, 2005, 2006 Martin Fuchs &lt;martin-fuchs(a)gmx.net&gt;
  //
+
+ /// \file xmlstorage.h
+ /// XMLStorage header file
 
 
 /*
@@ -347,14 +348,14 @@
 #ifndef XS_STRING_UTF8
 
  // from UTF-8 to XS internal string encoding
-inline void assign_utf8(XS_String& s, const char* str, int lutf8)
+inline void assign_utf8(XS_String& s, const char* str, size_t lutf8)
 {
 #ifdef UNICODE
 	LPTSTR buffer = (LPTSTR)alloca(sizeof(TCHAR)*lutf8);
-	int l = MultiByteToWideChar(CP_UTF8, 0, str, lutf8, buffer, lutf8);
+	int l = MultiByteToWideChar(CP_UTF8, 0, str, (int)lutf8, buffer, (int)lutf8);
 #else
 	LPWSTR wbuffer = (LPWSTR)alloca(sizeof(WCHAR)*lutf8);
-	int l = MultiByteToWideChar(CP_UTF8, 0, str, lutf8, wbuffer, lutf8);
+	int l = MultiByteToWideChar(CP_UTF8, 0, str, (int)lutf8, wbuffer, (int)lutf8);
 
 	int bl=2*l; LPSTR buffer = (LPSTR)alloca(bl);
 	l = WideCharToMultiByte(CP_ACP, 0, wbuffer, l, buffer, bl, 0, 0);
@@ -419,6 +420,7 @@
 typedef std::filebuf STDIO_FILEBUF;
 #endif
 
+ /// base class for XMLStorage::tifstream and XMLStorage::tofstream
 struct FileHolder
 {
 	FileHolder(LPCTSTR path, LPCTSTR mode)
@@ -553,6 +555,7 @@
 	int _error_code;
 };
 
+ /// list of XMLError entries
 struct XMLErrorList : public std::list<XMLError>
 {
 	XS_String str() const;
@@ -594,6 +597,7 @@
 };
 
 
+ /// XML Stylesheet entry
 struct StyleSheet
 {
 	std::string	_href;		// CDATA #REQUIRED
@@ -616,9 +620,10 @@
 	void print(std::ostream& out) const;
 };
 
+ /// list of StyleSheet entries
 struct StyleSheetList : public std::list<StyleSheet>
 {
-	void	set(const StyleSheet& stylesheet)
+	void set(const StyleSheet& stylesheet)
 	{
 		clear();
 		push_back(stylesheet);
@@ -626,6 +631,7 @@
 };
 
 
+ /// XML document type description
 struct DocType
 {
 	std::string	_name;
@@ -683,6 +689,7 @@
 struct XMLNode : public XS_String
 {
 #if defined(UNICODE) && !defined(XS_STRING_UTF8)
+	 /// map of XML node attributes
 	 // optimized read access without temporary A/U conversion when using ASCII attribute
names
 	struct AttributeMap : public std::map<XS_String, XS_String>
 	{
@@ -718,6 +725,7 @@
 		}
 	};
 #else
+	 /// map of XML node attributes
 	struct AttributeMap : public std::map<XS_String, XS_String>
 	{
 		XS_String get(const char* x, LPXSSTR def=XS_EMPTY_STR) const
@@ -2280,6 +2288,7 @@
 };
 
 
+ /// helper structure to read XML messages from strings
 struct XMLMessageFromString : public XMLMessage
 {
 	XMLMessageFromString(const std::string& xml_str, const std::string&
system_id=std::string())
@@ -2308,6 +2317,7 @@
 };
 
 
+ /// on the fly XML writer
 struct XMLWriter
 {
 	XMLWriter(std::ostream& out, const XMLFormat& format=XMLFormat())
@@ -2399,6 +2409,7 @@
 
 	typedef XMLNode::AttributeMap AttrMap;
 
+	 /// container for XMLWriter state information
 	struct StackEntry {
 		XS_String	_node_name;
 		AttrMap		_attributes;

Modified: trunk/reactos/base/shell/explorer/utility/xs-native.cpp
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/base/shell/explorer/utilit…
==============================================================================
--- trunk/reactos/base/shell/explorer/utility/xs-native.cpp (original)
+++ trunk/reactos/base/shell/explorer/utility/xs-native.cpp Thu Aug 10 01:27:05 2006
@@ -1,11 +1,12 @@
 
  //
- // XML storage classes
- //
- // xs-native.cpp
+ // XML storage classes Version 1.1
  //
  // Copyright (c) 2006 Martin Fuchs &lt;martin-fuchs(a)gmx.net&gt;
  //
+
+ /// \file xs-native.cpp
+ /// native internal XMLStorage parser
 
 
 /*
@@ -70,6 +71,8 @@
 }
 
 
+ /// line buffer for XS-native parser
+
 struct Buffer
 {
 	Buffer()