From cbfa772361de5589b3c4bb9fec15a23d0e150eb3 Mon Sep 17 00:00:00 2001
From: Simon Gockner <simon.gockner@gmail.com>
Date: Wed, 12 Feb 2020 12:01:06 +0100
Subject: [PATCH] #10: add class and function comments for dataHandling
 factories

---
 GBase/GBase.xml                               | 75 +++++++++++++++++++
 .../IXmlDataHandlerCacheEntryFactory.cs       | 10 +++
 .../Factories/IXmlDataHandlerCacheFactory.cs  |  8 ++
 ...XmlDataHandlerCachePropertyEntryFactory.cs |  9 +++
 .../Xml/Factories/IXmlDataHandlerFactory.cs   |  7 ++
 .../Xml/Factories/IXmlDataReaderFactory.cs    |  8 ++
 .../Xml/Factories/IXmlDataWriterFactory.cs    |  9 +++
 7 files changed, 126 insertions(+)

diff --git a/GBase/GBase.xml b/GBase/GBase.xml
index 045a197..18a74aa 100644
--- a/GBase/GBase.xml
+++ b/GBase/GBase.xml
@@ -494,6 +494,45 @@
             <param name="value">The value to set</param>
             <returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
         </member>
+        <member name="T:GBase.Interfaces.DataHandling.Xml.Cache.Factories.IXmlDataHandlerCacheEntryFactory">
+            <summary>
+            Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCacheEntry"/>
+            </summary>
+        </member>
+        <member name="M:GBase.Interfaces.DataHandling.Xml.Cache.Factories.IXmlDataHandlerCacheEntryFactory.Create(System.Type,System.String,System.Object)">
+            <summary>
+            Create an <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCacheEntry"/>
+            </summary>
+            <param name="type">The <see cref="T:System.Type"/> that implements the property</param>
+            <param name="propertyName">The name of the property</param>
+            <param name="value">The value of the property</param>
+            <returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCacheEntry"/></returns>
+        </member>
+        <member name="T:GBase.Interfaces.DataHandling.Xml.Cache.Factories.IXmlDataHandlerCacheFactory">
+            <summary>
+            Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/>
+            </summary>
+        </member>
+        <member name="M:GBase.Interfaces.DataHandling.Xml.Cache.Factories.IXmlDataHandlerCacheFactory.Create(GBase.Interfaces.DataHandling.Xml.IXmlDataReader)">
+            <summary>
+            Creates an <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/>
+            </summary>
+            <param name="xmlDataReader">The <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/></param>
+            <returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/></returns>
+        </member>
+        <member name="T:GBase.Interfaces.DataHandling.Xml.Cache.Factories.IXmlDataHandlerCachePropertyEntryFactory">
+            <summary>
+            Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCachePropertyEntry"/>
+            </summary>
+        </member>
+        <member name="M:GBase.Interfaces.DataHandling.Xml.Cache.Factories.IXmlDataHandlerCachePropertyEntryFactory.Create(System.String,System.Object)">
+            <summary>
+            Creates an <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCachePropertyEntry"/>
+            </summary>
+            <param name="propertyName">The name of the property</param>
+            <param name="value">The value of the property</param>
+            <returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCachePropertyEntry"/></returns>
+        </member>
         <member name="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache">
             <summary>
             An interface for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/>
@@ -509,6 +548,42 @@
             A property entry for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCacheEntry"/>
             </summary>
         </member>
+        <member name="T:GBase.Interfaces.DataHandling.Xml.Factories.IXmlDataHandlerFactory">
+            <summary>
+            Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataHandler"/>
+            </summary>
+        </member>
+        <member name="M:GBase.Interfaces.DataHandling.Xml.Factories.IXmlDataHandlerFactory.Create">
+            <summary>
+            Creates an <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataHandler"/>
+            </summary>
+            <returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataHandler"/></returns>
+        </member>
+        <member name="T:GBase.Interfaces.DataHandling.Xml.Factories.IXmlDataReaderFactory">
+            <summary>
+            Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/>
+            </summary>
+        </member>
+        <member name="M:GBase.Interfaces.DataHandling.Xml.Factories.IXmlDataReaderFactory.Create(System.String)">
+            <summary>
+            Creates an <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/>
+            </summary>
+            <param name="path">The path to the xml file</param>
+            <returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/></returns>
+        </member>
+        <member name="T:GBase.Interfaces.DataHandling.Xml.Factories.IXmlDataWriterFactory">
+            <summary>
+            Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter"/>
+            </summary>
+        </member>
+        <member name="M:GBase.Interfaces.DataHandling.Xml.Factories.IXmlDataWriterFactory.Create(System.String,System.String)">
+            <summary>
+            Creates an <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter"/>
+            </summary>
+            <param name="path">The path to the xml file</param>
+            <param name="rootElementName">The root element name of the xml file</param>
+            <returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter"/></returns>
+        </member>
         <member name="T:GBase.Interfaces.DataHandling.Xml.IXmlDataHandler">
             <summary>
             A <see cref="T:GBase.Interfaces.DataHandling.IDataHandler"/> that handles its data in an xml file
diff --git a/GBase/Interfaces/DataHandling/Xml/Cache/Factories/IXmlDataHandlerCacheEntryFactory.cs b/GBase/Interfaces/DataHandling/Xml/Cache/Factories/IXmlDataHandlerCacheEntryFactory.cs
index fce263e..f5ca37b 100644
--- a/GBase/Interfaces/DataHandling/Xml/Cache/Factories/IXmlDataHandlerCacheEntryFactory.cs
+++ b/GBase/Interfaces/DataHandling/Xml/Cache/Factories/IXmlDataHandlerCacheEntryFactory.cs
@@ -6,8 +6,18 @@ using System;
 
 namespace GBase.Interfaces.DataHandling.Xml.Cache.Factories
 {
+    /// <summary>
+    /// Factory for the <see cref="IXmlDataHandlerCacheEntry"/>
+    /// </summary>
     public interface IXmlDataHandlerCacheEntryFactory
     {
+        /// <summary>
+        /// Create an <see cref="IXmlDataHandlerCacheEntry"/>
+        /// </summary>
+        /// <param name="type">The <see cref="Type"/> that implements the property</param>
+        /// <param name="propertyName">The name of the property</param>
+        /// <param name="value">The value of the property</param>
+        /// <returns>A newly created instance of the implementation for <see cref="IXmlDataHandlerCacheEntry"/></returns>
         IXmlDataHandlerCacheEntry Create(Type type, string propertyName, object value);
     }
 }
\ No newline at end of file
diff --git a/GBase/Interfaces/DataHandling/Xml/Cache/Factories/IXmlDataHandlerCacheFactory.cs b/GBase/Interfaces/DataHandling/Xml/Cache/Factories/IXmlDataHandlerCacheFactory.cs
index ffb517f..8ebc61a 100644
--- a/GBase/Interfaces/DataHandling/Xml/Cache/Factories/IXmlDataHandlerCacheFactory.cs
+++ b/GBase/Interfaces/DataHandling/Xml/Cache/Factories/IXmlDataHandlerCacheFactory.cs
@@ -4,8 +4,16 @@
 
 namespace GBase.Interfaces.DataHandling.Xml.Cache.Factories
 {
+    /// <summary>
+    /// Factory for the <see cref="IXmlDataHandlerCache"/>
+    /// </summary>
     public interface IXmlDataHandlerCacheFactory
     {
+        /// <summary>
+        /// Creates an <see cref="IXmlDataHandlerCache"/>
+        /// </summary>
+        /// <param name="xmlDataReader">The <see cref="IXmlDataReader"/></param>
+        /// <returns>A newly created instance of the implementation for <see cref="IXmlDataHandlerCache"/></returns>
         IXmlDataHandlerCache Create(IXmlDataReader xmlDataReader);
     }
 }
\ No newline at end of file
diff --git a/GBase/Interfaces/DataHandling/Xml/Cache/Factories/IXmlDataHandlerCachePropertyEntryFactory.cs b/GBase/Interfaces/DataHandling/Xml/Cache/Factories/IXmlDataHandlerCachePropertyEntryFactory.cs
index 23ef25c..d80bebd 100644
--- a/GBase/Interfaces/DataHandling/Xml/Cache/Factories/IXmlDataHandlerCachePropertyEntryFactory.cs
+++ b/GBase/Interfaces/DataHandling/Xml/Cache/Factories/IXmlDataHandlerCachePropertyEntryFactory.cs
@@ -4,8 +4,17 @@
 
 namespace GBase.Interfaces.DataHandling.Xml.Cache.Factories
 {
+    /// <summary>
+    /// Factory for the <see cref="IXmlDataHandlerCachePropertyEntry"/>
+    /// </summary>
     public interface IXmlDataHandlerCachePropertyEntryFactory
     {
+        /// <summary>
+        /// Creates an <see cref="IXmlDataHandlerCachePropertyEntry"/>
+        /// </summary>
+        /// <param name="propertyName">The name of the property</param>
+        /// <param name="value">The value of the property</param>
+        /// <returns>A newly created instance of the implementation for <see cref="IXmlDataHandlerCachePropertyEntry"/></returns>
         IXmlDataHandlerCachePropertyEntry Create(string propertyName, object value);
     }
 }
\ No newline at end of file
diff --git a/GBase/Interfaces/DataHandling/Xml/Factories/IXmlDataHandlerFactory.cs b/GBase/Interfaces/DataHandling/Xml/Factories/IXmlDataHandlerFactory.cs
index 52b5f53..7f303f8 100644
--- a/GBase/Interfaces/DataHandling/Xml/Factories/IXmlDataHandlerFactory.cs
+++ b/GBase/Interfaces/DataHandling/Xml/Factories/IXmlDataHandlerFactory.cs
@@ -4,8 +4,15 @@
 
 namespace GBase.Interfaces.DataHandling.Xml.Factories
 {
+    /// <summary>
+    /// Factory for the <see cref="IXmlDataHandler"/>
+    /// </summary>
     public interface IXmlDataHandlerFactory
     {
+        /// <summary>
+        /// Creates an <see cref="IXmlDataHandler"/>
+        /// </summary>
+        /// <returns>A newly created instance of the implementation for <see cref="IXmlDataHandler"/></returns>
         IXmlDataHandler Create();
     }
 }
\ No newline at end of file
diff --git a/GBase/Interfaces/DataHandling/Xml/Factories/IXmlDataReaderFactory.cs b/GBase/Interfaces/DataHandling/Xml/Factories/IXmlDataReaderFactory.cs
index e573acd..ce4fe53 100644
--- a/GBase/Interfaces/DataHandling/Xml/Factories/IXmlDataReaderFactory.cs
+++ b/GBase/Interfaces/DataHandling/Xml/Factories/IXmlDataReaderFactory.cs
@@ -4,8 +4,16 @@
 
 namespace GBase.Interfaces.DataHandling.Xml.Factories
 {
+    /// <summary>
+    /// Factory for the <see cref="IXmlDataReader"/>
+    /// </summary>
     public interface IXmlDataReaderFactory
     {
+        /// <summary>
+        /// Creates an <see cref="IXmlDataReader"/>
+        /// </summary>
+        /// <param name="path">The path to the xml file</param>
+        /// <returns>A newly created instance of the implementation for <see cref="IXmlDataReader"/></returns>
         IXmlDataReader Create(string path);
     }
 }
\ No newline at end of file
diff --git a/GBase/Interfaces/DataHandling/Xml/Factories/IXmlDataWriterFactory.cs b/GBase/Interfaces/DataHandling/Xml/Factories/IXmlDataWriterFactory.cs
index 9c2db97..785c56a 100644
--- a/GBase/Interfaces/DataHandling/Xml/Factories/IXmlDataWriterFactory.cs
+++ b/GBase/Interfaces/DataHandling/Xml/Factories/IXmlDataWriterFactory.cs
@@ -4,8 +4,17 @@
 
 namespace GBase.Interfaces.DataHandling.Xml.Factories
 {
+    /// <summary>
+    /// Factory for the <see cref="IXmlDataWriter"/>
+    /// </summary>
     public interface IXmlDataWriterFactory
     {
+        /// <summary>
+        /// Creates an <see cref="IXmlDataWriter"/>
+        /// </summary>
+        /// <param name="path">The path to the xml file</param>
+        /// <param name="rootElementName">The root element name of the xml file</param>
+        /// <returns>A newly created instance of the implementation for <see cref="IXmlDataWriter"/></returns>
         IXmlDataWriter Create(string path, string rootElementName);
     }
 }
\ No newline at end of file