#10: add class and function comments for dataHandling factories

pull/26/head
Simon Gockner 6 years ago
parent 6038278a3d
commit cbfa772361
  1. 75
      GBase/GBase.xml
  2. 10
      GBase/Interfaces/DataHandling/Xml/Cache/Factories/IXmlDataHandlerCacheEntryFactory.cs
  3. 8
      GBase/Interfaces/DataHandling/Xml/Cache/Factories/IXmlDataHandlerCacheFactory.cs
  4. 9
      GBase/Interfaces/DataHandling/Xml/Cache/Factories/IXmlDataHandlerCachePropertyEntryFactory.cs
  5. 7
      GBase/Interfaces/DataHandling/Xml/Factories/IXmlDataHandlerFactory.cs
  6. 8
      GBase/Interfaces/DataHandling/Xml/Factories/IXmlDataReaderFactory.cs
  7. 9
      GBase/Interfaces/DataHandling/Xml/Factories/IXmlDataWriterFactory.cs

@ -494,6 +494,45 @@
<param name="value">The value to set</param> <param name="value">The value to set</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns> <returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
</member> </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"> <member name="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache">
<summary> <summary>
An interface for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/> 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"/> A property entry for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCacheEntry"/>
</summary> </summary>
</member> </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"> <member name="T:GBase.Interfaces.DataHandling.Xml.IXmlDataHandler">
<summary> <summary>
A <see cref="T:GBase.Interfaces.DataHandling.IDataHandler"/> that handles its data in an xml file A <see cref="T:GBase.Interfaces.DataHandling.IDataHandler"/> that handles its data in an xml file

@ -6,8 +6,18 @@ using System;
namespace GBase.Interfaces.DataHandling.Xml.Cache.Factories namespace GBase.Interfaces.DataHandling.Xml.Cache.Factories
{ {
/// <summary>
/// Factory for the <see cref="IXmlDataHandlerCacheEntry"/>
/// </summary>
public interface IXmlDataHandlerCacheEntryFactory 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); IXmlDataHandlerCacheEntry Create(Type type, string propertyName, object value);
} }
} }

@ -4,8 +4,16 @@
namespace GBase.Interfaces.DataHandling.Xml.Cache.Factories namespace GBase.Interfaces.DataHandling.Xml.Cache.Factories
{ {
/// <summary>
/// Factory for the <see cref="IXmlDataHandlerCache"/>
/// </summary>
public interface IXmlDataHandlerCacheFactory 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); IXmlDataHandlerCache Create(IXmlDataReader xmlDataReader);
} }
} }

@ -4,8 +4,17 @@
namespace GBase.Interfaces.DataHandling.Xml.Cache.Factories namespace GBase.Interfaces.DataHandling.Xml.Cache.Factories
{ {
/// <summary>
/// Factory for the <see cref="IXmlDataHandlerCachePropertyEntry"/>
/// </summary>
public interface IXmlDataHandlerCachePropertyEntryFactory 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); IXmlDataHandlerCachePropertyEntry Create(string propertyName, object value);
} }
} }

@ -4,8 +4,15 @@
namespace GBase.Interfaces.DataHandling.Xml.Factories namespace GBase.Interfaces.DataHandling.Xml.Factories
{ {
/// <summary>
/// Factory for the <see cref="IXmlDataHandler"/>
/// </summary>
public interface IXmlDataHandlerFactory 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(); IXmlDataHandler Create();
} }
} }

@ -4,8 +4,16 @@
namespace GBase.Interfaces.DataHandling.Xml.Factories namespace GBase.Interfaces.DataHandling.Xml.Factories
{ {
/// <summary>
/// Factory for the <see cref="IXmlDataReader"/>
/// </summary>
public interface IXmlDataReaderFactory 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); IXmlDataReader Create(string path);
} }
} }

@ -4,8 +4,17 @@
namespace GBase.Interfaces.DataHandling.Xml.Factories namespace GBase.Interfaces.DataHandling.Xml.Factories
{ {
/// <summary>
/// Factory for the <see cref="IXmlDataWriter"/>
/// </summary>
public interface IXmlDataWriterFactory 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); IXmlDataWriter Create(string path, string rootElementName);
} }
} }
Loading…
Cancel
Save