missing documentation

mydeveloperday · mydeveloperday · commit 815c55a69269 · 2015-12-27T23:38:17.000Z
diff --git a/src/framework/Path.h b/src/framework/Path.h
@@ -17,6 +17,7 @@ namespace System
         /// get the filename for from the path
         static System::String GetFileName(const System::String &a);
 
+        /// get the fullpath from a filename
         static System::String GetFullPath(const System::String &a);
     };
 }
diff --git a/src/framework/System/String.h b/src/framework/System/String.h
@@ -45,13 +45,13 @@ namespace System
             return m_str;
         }
 
-        // an std::string casting converter (NOT .NET call)
+        /// an std::string casting converter (NOT .NET call)
         const std::string operator()(std::string&) const
         {
             return str();
         }
 
-        // an const char* casting converter (NOT .NET call)
+        /// an const char* casting converter (NOT .NET call)
         const char* operator()(const char*) const
         {
             return str().c_str();
diff --git a/src/framework/System/Xml.h b/src/framework/System/Xml.h
@@ -3,6 +3,11 @@
 #include "System/String.h"
 #include "System/IO.h"
 
+/// xml document class
+namespace System
+{
+namespace Xml
+{
 class XmlDocument
 {
     public:
@@ -11,8 +16,14 @@ class XmlDocument
     XmlDocument()
     {}
 
-    void LoadXml(const System::String &file)
+    /// load the xml from a string
+    void LoadXml(const System::String &str)
     {
-        static_cast<void>(file);
+        static_cast<void>(str);
     }
 };
+}
+}
+
+using namespace System::Xml;
+

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ namespace System`
`17`	`17`	`/// get the filename for from the path`
`18`	`18`	`static System::String GetFileName(const System::String &a);`
`19`	`19`
	`20`	`+ /// get the fullpath from a filename`
`20`	`21`	`static System::String GetFullPath(const System::String &a);`
`21`	`22`	`};`
`22`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,13 +45,13 @@ namespace System`
`45`	`45`	`return m_str;`
`46`	`46`	`}`
`47`	`47`
`48`		`- // an std::string casting converter (NOT .NET call)`
	`48`	`+ /// an std::string casting converter (NOT .NET call)`
`49`	`49`	`const std::string operator()(std::string&) const`
`50`	`50`	`{`
`51`	`51`	`return str();`
`52`	`52`	`}`
`53`	`53`
`54`		`- // an const char* casting converter (NOT .NET call)`
	`54`	`+ /// an const char* casting converter (NOT .NET call)`
`55`	`55`	`const char* operator()(const char*) const`
`56`	`56`	`{`
`57`	`57`	`return str().c_str();`