Comments plus spell fix

npodbielski · npodbielski · commit 9bbd54212624 · 2017-01-26T07:29:22.000+01:00
diff --git a/src/DelegatesFactory/CustomDelegates/StructGetFunc.cs b/src/DelegatesFactory/CustomDelegates/StructGetFunc.cs
@@ -6,5 +6,12 @@
 
 namespace Delegates.CustomDelegates
 {
+    /// <summary>
+    /// Delegates for returning value of property from structure type by reference.
+    /// </summary>
+    /// <typeparam name="T">Type of structure</typeparam>
+    /// <typeparam name="TProp">Property type</typeparam>
+    /// <param name="i">Structure type instance</param>
+    /// <returns>Value of a property</returns>
     public delegate TProp StructGetFunc<T, out TProp>(ref T i) where T : struct;
 }
diff --git a/src/DelegatesFactory/CustomDelegates/StructIndex1GetFunc.cs b/src/DelegatesFactory/CustomDelegates/StructIndex1GetFunc.cs
@@ -6,5 +6,14 @@
 
 namespace Delegates.CustomDelegates
 {
-    public delegate TProp StructIndex1GetFunc<T, in TI1, out TProp>(ref T i, TI1 i1) where T : struct;
+    /// <summary>
+    /// Delegates for returning value of indexer with single index parameter from structure type by reference.
+    /// </summary>
+    /// <typeparam name="T">Structure type</typeparam>
+    /// <typeparam name="TI1">Index parameter type</typeparam>
+    /// <typeparam name="TReturn">Index return type</typeparam>
+    /// <param name="instance">Structure type instance</param>
+    /// <param name="index">Index parameter</param>
+    /// <returns>Value of indexer at given index</returns>
+    public delegate TReturn StructIndex1GetFunc<T, in TI1, out TReturn>(ref T instance, TI1 index) where T : struct;
 }
diff --git a/src/DelegatesFactory/CustomDelegates/StructIndex1SetAction.cs b/src/DelegatesFactory/CustomDelegates/StructIndex1SetAction.cs
@@ -6,5 +6,14 @@
 
 namespace Delegates.CustomDelegates
 {
+    /// <summary>
+    /// Delegates for setting value of indexer with single index parameter in structure type by reference.
+    /// </summary>
+    /// <typeparam name="T">Structure type</typeparam>
+    /// <typeparam name="TI1">Index parameter type</typeparam>
+    /// <typeparam name="TProp">Property type</typeparam>
+    /// <param name="i">Structure type instance</param>
+    /// <param name="i1">Index parameter</param>
+    /// <param name="value">Value of indexer to set at given parameter</param>
     public delegate void StructIndex1SetAction<T, in TI1, in TProp>(ref T i, TI1 i1, TProp value);
 }
diff --git a/src/DelegatesFactory/CustomDelegates/StructIndex2GetFunc.cs b/src/DelegatesFactory/CustomDelegates/StructIndex2GetFunc.cs
@@ -6,5 +6,16 @@
 
 namespace Delegates.CustomDelegates
 {
+    /// <summary>
+    /// Delegates for returning value of indexer with two index parameters from structure type by reference.
+    /// </summary>
+    /// <typeparam name="T">Structure type</typeparam>
+    /// <typeparam name="TI1">First index parameter type</typeparam>
+    /// <typeparam name="TI2">Second index parameter type</typeparam>
+    /// <typeparam name="TProp">Property type</typeparam>
+    /// <param name="i">Structure type instance</param>
+    /// <param name="i1">First index parameter</param>
+    /// <param name="i2">Second index parameter</param>
+    /// <returns>Value of indexer at given index parameters</returns>
     public delegate TProp StructIndex2GetFunc<T, in TI1, in TI2, out TProp>(ref T i, TI1 i1, TI2 i2) where T : struct;
 }
diff --git a/src/DelegatesFactory/CustomDelegates/StructIndex2SetAction.cs b/src/DelegatesFactory/CustomDelegates/StructIndex2SetAction.cs
@@ -6,5 +6,16 @@
 
 namespace Delegates.CustomDelegates
 {
+    /// <summary>
+    /// Delegates for setting value of indexer with two index parameters in structure type by reference.
+    /// </summary>
+    /// <typeparam name="T">Structure type</typeparam>
+    /// <typeparam name="TI1">First index parameter type</typeparam>
+    /// <typeparam name="TI2">Second index parameter type</typeparam>
+    /// <typeparam name="TProp">Property type</typeparam>
+    /// <param name="i">Structure type instance</param>
+    /// <param name="i1">First index parameter</param>
+    /// <param name="i2">Second index parameter</param>
+    /// <param name="value">Value of indexer to set at given index parameters</param>
     public delegate void StructIndex2SetAction<T, in TI1, in TI2, in TProp>(ref T i, TI1 i1, TI2 i2, TProp value);
 }
diff --git a/src/DelegatesFactory/CustomDelegates/StructIndex3GetFunc.cs b/src/DelegatesFactory/CustomDelegates/StructIndex3GetFunc.cs
@@ -6,6 +6,19 @@
 
 namespace Delegates.CustomDelegates
 {
+    /// <summary>
+    /// Delegates for returning value of indexer with three index parameters from structure type by reference.
+    /// </summary>
+    /// <typeparam name="T">Structure type</typeparam>
+    /// <typeparam name="TI1">First index parameter type</typeparam>
+    /// <typeparam name="TI2">Second index parameter type</typeparam>
+    /// <typeparam name="TI3">Third index parameter type</typeparam>
+    /// <typeparam name="TProp">Property type</typeparam>
+    /// <param name="i">Structure type instance</param>
+    /// <param name="i1">First index parameter</param>
+    /// <param name="i2">Second index parameter</param>
+    /// <param name="i3">Third index parameter</param>
+    /// <returns>Value of indexer at given index parameters</returns>
     public delegate TProp StructIndex3GetFunc<T, in TI1, in TI2, in TI3, out TProp>(ref T i, TI1 i1, TI2 i2, TI3 i3)
         where T : struct;
 }
diff --git a/src/DelegatesFactory/CustomDelegates/StructIndex3SetAction.cs b/src/DelegatesFactory/CustomDelegates/StructIndex3SetAction.cs
@@ -6,6 +6,19 @@
 
 namespace Delegates.CustomDelegates
 {
+    /// <summary>
+    /// Delegates for setting value of indexer with three index parameters in structure type by reference.
+    /// </summary>
+    /// <typeparam name="T">Structure type</typeparam>
+    /// <typeparam name="TI1">First index parameter type</typeparam>
+    /// <typeparam name="TI2">Second index parameter type</typeparam>
+    /// <typeparam name="TI3">Third index parameter type</typeparam>
+    /// <typeparam name="TProp">Property type</typeparam>
+    /// <param name="i">Structure type instance</param>
+    /// <param name="i1">First index parameter</param>
+    /// <param name="i2">Second index parameter</param>
+    /// <param name="i3">Third index parameter</param>
+    /// <param name="value">Value of indexer to set at given index parameters</param>
     public delegate void StructIndex3SetAction<T, in TI1, in TI2, in TI3, in TProp>(
         ref T i, TI1 i1, TI2 i2, TI3 i3, TProp value);
 }
diff --git a/src/DelegatesFactory/CustomDelegates/StructIndexesSetAction.cs b/src/DelegatesFactory/CustomDelegates/StructIndexesSetAction.cs
@@ -6,5 +6,13 @@
 
 namespace Delegates.CustomDelegates
 {
-    public delegate void StructIndexesSetAction<T, in TProp>(ref T i, object[] indexes, TProp value);
+    /// <summary>
+    /// Delegates for setting value of indexer with unspecified index parameters in structure type by reference.
+    /// </summary>
+    /// <typeparam name="T">Structure type</typeparam>
+    /// <typeparam name="TValue">Value type</typeparam>
+    /// <param name="instance">Structure type instance</param>
+    /// <param name="indexes">Set of indexer index parameters</param>
+    /// <param name="value">Value of indexer to set at given index parameters</param>
+    public delegate void StructIndexesSetAction<T, in TValue>(ref T instance, object[] indexes, TValue value);
 }
diff --git a/src/DelegatesFactory/CustomDelegates/StructSetAction.cs b/src/DelegatesFactory/CustomDelegates/StructSetAction.cs
@@ -6,5 +6,13 @@
 
 namespace Delegates.CustomDelegates
 {
+    /// <summary>
+    /// Delegates for setting value of indexer with unspecified index parameters in structure type.
+    /// </summary>
+    /// <typeparam name="T">Structure type</typeparam>
+    /// <typeparam name="TProp">Property type</typeparam>
+    /// <param name="i">Structure type instance</param>
+    /// <param name="value">Value of indexer to set at given index parameters</param>
+    /// <returns>Changed structure value</returns>
     public delegate T StructSetAction<T, in TProp>(T i, TProp value);
 }
diff --git a/src/DelegatesFactory/CustomDelegates/StructSetActionRef.cs b/src/DelegatesFactory/CustomDelegates/StructSetActionRef.cs
@@ -6,5 +6,12 @@
 
 namespace Delegates
 {
+    /// <summary>
+    /// Delegates for setting value of indexer with single index parameter in structure type by reference.
+    /// </summary>
+    /// <typeparam name="T">Structure type</typeparam>
+    /// <typeparam name="TProp">Property type</typeparam>
+    /// <param name="i">Structure type instance</param>
+    /// <param name="value">Value of indexer to set at given index parameters</param>
     public delegate void StructSetActionRef<T, in TProp>(ref T i, TProp value);
 }
diff --git a/src/DelegatesFactory/Extensions/CEventInfo.cs b/src/DelegatesFactory/Extensions/CEventInfo.cs
@@ -9,21 +9,37 @@
 
 namespace Delegates.Extensions
 {
+    /// <summary>
+    /// Compatibility class (wrapper) if version of .NET do not support v4.5 of <see cref="EventInfo"/> class.
+    /// </summary>
     public class CEventInfo
     {
         private readonly EventInfo _event;
 
+        /// <summary>
+        /// Wrapper constructor
+        /// </summary>
+        /// <param name="event">Incompatible <see cref="EventInfo"/> class instance</param>
         public CEventInfo(EventInfo @event)
         {
             _event = @event;
         }
 
+        /// <summary>
+        /// Event add accessor.
+        /// </summary>
         public MethodInfo AddMethod => _event?.GetAddMethod() ??
                                        _event?.GetAddMethod(true);
 
+        /// <summary>
+        /// Proxy property of <see cref="EventInfo.EventHandlerType"/>
+        /// </summary>
+        public Type EventHandlerType => _event?.EventHandlerType;
+
+        /// <summary>
+        /// Event remove accessor.
+        /// </summary>
         public MethodInfo RemoveMethod => _event?.GetRemoveMethod() ??
                                           _event?.GetRemoveMethod(true);
-
-        public Type EventHandlerType => _event?.EventHandlerType;
     }
 }
diff --git a/src/DelegatesFactory/Extensions/CPropertyInfo.cs b/src/DelegatesFactory/Extensions/CPropertyInfo.cs
@@ -10,15 +10,25 @@
 
 namespace Delegates.Extensions
 {
+    /// <summary>
+    /// Compatibility class (wrapper) if version of .NET do not support v4.5 of <see cref="EventInfo"/> class.
+    /// </summary>
     public class CPropertyInfo
     {
         private readonly PropertyInfo _property;
 
+        /// <summary>
+        /// Wrapper constructor
+        /// </summary>
+        /// <param name="property">Incompatible <see cref="PropertyInfo"/> class instance</param>
         public CPropertyInfo(PropertyInfo property)
         {
             _property = property;
         }
 
+        /// <summary>
+        /// Property get accessor
+        /// </summary>
         public MethodInfo GetMethod
         {
             get
@@ -28,6 +38,14 @@ public MethodInfo GetMethod
             }
         }
 
+        /// <summary>
+        /// Proxy property of <see cref="PropertyInfo.PropertyType"/>
+        /// </summary>
+        public Type PropertyType => _property?.PropertyType;
+
+        /// <summary>
+        /// Property set accessor
+        /// </summary>
         public MethodInfo SetMethod
         {
             get
@@ -36,7 +54,5 @@ public MethodInfo SetMethod
                     .FirstOrDefault(a => a.Name.StartsWith("set"));
             }
         }
-
-        public Type PropertyType => _property?.PropertyType;
     }
 }
diff --git a/src/DelegatesFactory/Extensions/ExpressionsExtensions.cs b/src/DelegatesFactory/Extensions/ExpressionsExtensions.cs
diff --git a/src/DelegatesFactory/Extensions/TypeExtensions.cs b/src/DelegatesFactory/Extensions/TypeExtensions.cs
diff --git a/src/DelegatesFactory/Extensions/WeakReferenceExtensions.cs b/src/DelegatesFactory/Extensions/WeakReferenceExtensions.cs

Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,12 @@`
`6`	`6`
`7`	`7`	`namespace Delegates.CustomDelegates`
`8`	`8`	`{`
	`9`	`+ /// <summary>`
	`10`	`+ /// Delegates for returning value of property from structure type by reference.`
	`11`	`+ /// </summary>`
	`12`	`+ /// <typeparam name="T">Type of structure</typeparam>`
	`13`	`+ /// <typeparam name="TProp">Property type</typeparam>`
	`14`	`+ /// <param name="i">Structure type instance</param>`
	`15`	`+ /// <returns>Value of a property</returns>`
`9`	`16`	`public delegate TProp StructGetFunc<T, out TProp>(ref T i) where T : struct;`
`10`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,14 @@`
`6`	`6`
`7`	`7`	`namespace Delegates.CustomDelegates`
`8`	`8`	`{`
	`9`	`+ /// <summary>`
	`10`	`+ /// Delegates for setting value of indexer with single index parameter in structure type by reference.`
	`11`	`+ /// </summary>`
	`12`	`+ /// <typeparam name="T">Structure type</typeparam>`
	`13`	`+ /// <typeparam name="TI1">Index parameter type</typeparam>`
	`14`	`+ /// <typeparam name="TProp">Property type</typeparam>`
	`15`	`+ /// <param name="i">Structure type instance</param>`
	`16`	`+ /// <param name="i1">Index parameter</param>`
	`17`	`+ /// <param name="value">Value of indexer to set at given parameter</param>`
`9`	`18`	`public delegate void StructIndex1SetAction<T, in TI1, in TProp>(ref T i, TI1 i1, TProp value);`
`10`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,13 @@`
`6`	`6`
`7`	`7`	`namespace Delegates.CustomDelegates`
`8`	`8`	`{`
`9`		`- public delegate void StructIndexesSetAction<T, in TProp>(ref T i, object[] indexes, TProp value);`
	`9`	`+ /// <summary>`
	`10`	`+ /// Delegates for setting value of indexer with unspecified index parameters in structure type by reference.`
	`11`	`+ /// </summary>`
	`12`	`+ /// <typeparam name="T">Structure type</typeparam>`
	`13`	`+ /// <typeparam name="TValue">Value type</typeparam>`
	`14`	`+ /// <param name="instance">Structure type instance</param>`
	`15`	`+ /// <param name="indexes">Set of indexer index parameters</param>`
	`16`	`+ /// <param name="value">Value of indexer to set at given index parameters</param>`
	`17`	`+ public delegate void StructIndexesSetAction<T, in TValue>(ref T instance, object[] indexes, TValue value);`
`10`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,12 @@`
`6`	`6`
`7`	`7`	`namespace Delegates`
`8`	`8`	`{`
	`9`	`+ /// <summary>`
	`10`	`+ /// Delegates for setting value of indexer with single index parameter in structure type by reference.`
	`11`	`+ /// </summary>`
	`12`	`+ /// <typeparam name="T">Structure type</typeparam>`
	`13`	`+ /// <typeparam name="TProp">Property type</typeparam>`
	`14`	`+ /// <param name="i">Structure type instance</param>`
	`15`	`+ /// <param name="value">Value of indexer to set at given index parameters</param>`
`9`	`16`	`public delegate void StructSetActionRef<T, in TProp>(ref T i, TProp value);`
`10`	`17`	`}`