Index: Core/Common/src/Core.Common.Utils/Attributes/ResourceHelper.cs
===================================================================
diff -u -r4512af7782ee31b36941bb280b54d9da2953dd71 -rb7c2e788d70b36d8fdabb8b7f56e2184df85b550
--- Core/Common/src/Core.Common.Utils/Attributes/ResourceHelper.cs (.../ResourceHelper.cs) (revision 4512af7782ee31b36941bb280b54d9da2953dd71)
+++ Core/Common/src/Core.Common.Utils/Attributes/ResourceHelper.cs (.../ResourceHelper.cs) (revision b7c2e788d70b36d8fdabb8b7f56e2184df85b550)
@@ -35,8 +35,8 @@
/// Type of the resource file.
/// Name of the resource property to be retrieved.
/// String resource in the resources file.
- /// Resource cannot be found or does
- /// not have the given resource name or isn't of type string.
+ /// Thrown when the resource cannot be found,
+ /// does not have the given resource name, or isn't of type string.
internal static string GetResourceLookup(Type resourceType, string resourceName)
{
var property = resourceType.GetProperty(resourceName, BindingFlags.NonPublic | BindingFlags.Public | BindingFlags.Static);
Index: Core/Common/src/Core.Common.Utils/Attributes/ResourcesCategoryAttribute.cs
===================================================================
diff -u -r24da3aa72ccc0776599628c9f971081694048d9a -rb7c2e788d70b36d8fdabb8b7f56e2184df85b550
--- Core/Common/src/Core.Common.Utils/Attributes/ResourcesCategoryAttribute.cs (.../ResourcesCategoryAttribute.cs) (revision 24da3aa72ccc0776599628c9f971081694048d9a)
+++ Core/Common/src/Core.Common.Utils/Attributes/ResourcesCategoryAttribute.cs (.../ResourcesCategoryAttribute.cs) (revision b7c2e788d70b36d8fdabb8b7f56e2184df85b550)
@@ -39,8 +39,8 @@
/// Name of the string resource property to be used as category.
/// The position of the category.
/// The total amount of categories in the control.
- /// Resource cannot be found or does
- /// not have the given resource name.
+ /// Thrown when the resource cannot be found
+ /// or does not have the given resource name.
/// Implemented as proposed at http://stackoverflow.com/a/21441892/.
public ResourcesCategoryAttribute(Type resourceType, string resourceName, ushort position = 0, ushort totalCategories = 0) :
base(ResourceHelper.GetResourceLookup(resourceType, resourceName)
Index: Core/Common/src/Core.Common.Utils/Attributes/ResourcesDescriptionAttribute.cs
===================================================================
diff -u -r4512af7782ee31b36941bb280b54d9da2953dd71 -rb7c2e788d70b36d8fdabb8b7f56e2184df85b550
--- Core/Common/src/Core.Common.Utils/Attributes/ResourcesDescriptionAttribute.cs (.../ResourcesDescriptionAttribute.cs) (revision 4512af7782ee31b36941bb280b54d9da2953dd71)
+++ Core/Common/src/Core.Common.Utils/Attributes/ResourcesDescriptionAttribute.cs (.../ResourcesDescriptionAttribute.cs) (revision b7c2e788d70b36d8fdabb8b7f56e2184df85b550)
@@ -35,8 +35,9 @@
///
/// Type of the resource file.
/// Name of the string resource property to be used as description.
- /// Resource cannot be found or does
- /// not have the given resource name.
- public ResourcesDescriptionAttribute(Type resourceType, string resourceName) : base(ResourceHelper.GetResourceLookup(resourceType, resourceName)) {}
+ /// Thrown when the resource cannot be found
+ /// or does not have the given resource name.
+ public ResourcesDescriptionAttribute(Type resourceType, string resourceName) :
+ base(ResourceHelper.GetResourceLookup(resourceType, resourceName)) {}
}
}
\ No newline at end of file
Index: Core/Common/src/Core.Common.Utils/Attributes/ResourcesDisplayNameAttribute.cs
===================================================================
diff -u -reaa8b3e276e1a0a6a4d0a2f96016879d8d12d394 -rb7c2e788d70b36d8fdabb8b7f56e2184df85b550
--- Core/Common/src/Core.Common.Utils/Attributes/ResourcesDisplayNameAttribute.cs (.../ResourcesDisplayNameAttribute.cs) (revision eaa8b3e276e1a0a6a4d0a2f96016879d8d12d394)
+++ Core/Common/src/Core.Common.Utils/Attributes/ResourcesDisplayNameAttribute.cs (.../ResourcesDisplayNameAttribute.cs) (revision b7c2e788d70b36d8fdabb8b7f56e2184df85b550)
@@ -36,8 +36,9 @@
///
/// Type of the resource file.
/// Name of the string resource property to be used as display name.
- /// Resource cannot be found or does
- /// not have the given resource name.
- public ResourcesDisplayNameAttribute(Type resourceType, string resourceName) : base(ResourceHelper.GetResourceLookup(resourceType, resourceName)) {}
+ /// Thrown when the resource cannot be found
+ /// or does not have the given resource name.
+ public ResourcesDisplayNameAttribute(Type resourceType, string resourceName) :
+ base(ResourceHelper.GetResourceLookup(resourceType, resourceName)) {}
}
}
\ No newline at end of file
Index: Core/Common/src/Core.Common.Utils/Drawing/GraphicsExtensions.cs
===================================================================
diff -u -r24da3aa72ccc0776599628c9f971081694048d9a -rb7c2e788d70b36d8fdabb8b7f56e2184df85b550
--- Core/Common/src/Core.Common.Utils/Drawing/GraphicsExtensions.cs (.../GraphicsExtensions.cs) (revision 24da3aa72ccc0776599628c9f971081694048d9a)
+++ Core/Common/src/Core.Common.Utils/Drawing/GraphicsExtensions.cs (.../GraphicsExtensions.cs) (revision b7c2e788d70b36d8fdabb8b7f56e2184df85b550)
@@ -39,7 +39,7 @@
/// The x-coordinate of the upper-left corner of the drawn image.
/// The y-coordinate of the upper-left corner of the drawn image.
/// The opacity for the image.
- /// is null.
+ /// Thrown when is null.
///
public static void DrawImageTransparent(this Graphics g, Image image, int x, int y, float opacity)
{
Index: Core/Common/src/Core.Common.Utils/Extensions/ComparableExtensions.cs
===================================================================
diff -u -r4512af7782ee31b36941bb280b54d9da2953dd71 -rb7c2e788d70b36d8fdabb8b7f56e2184df85b550
--- Core/Common/src/Core.Common.Utils/Extensions/ComparableExtensions.cs (.../ComparableExtensions.cs) (revision 4512af7782ee31b36941bb280b54d9da2953dd71)
+++ Core/Common/src/Core.Common.Utils/Extensions/ComparableExtensions.cs (.../ComparableExtensions.cs) (revision b7c2e788d70b36d8fdabb8b7f56e2184df85b550)
@@ -33,10 +33,10 @@
///
/// The first object.
/// The second object.
- /// True if is considered greater then ,
- /// false otherwise.
+ /// True if is considered greater then ,
+ /// false otherwise.
/// null is considered smaller than any other not-null value.
- /// Object type of
+ /// Thrown when object type of
/// is not the same as that of .
public static bool IsBigger(this IComparable object1, IComparable object2)
{
@@ -57,10 +57,10 @@
///
/// The first object.
/// The second object.
- /// True if is considered smaller then ,
- /// false otherwise.
+ /// True if is considered smaller then ,
+ /// false otherwise.
/// null is considered smaller then any not-null value.
- /// Object type of
+ /// Thrown when object type of
/// is not the same as that of .
public static bool IsSmaller(this IComparable object1, IComparable object2)
{
@@ -78,8 +78,9 @@
/// Value to be checked.
/// First range value.
/// Second range value.
- /// True if falls within the inclusive bounds, false otherwise.
- /// Object type of
+ /// True if falls within the inclusive bounds,
+ /// false otherwise.
+ /// Thrown when object type of
/// is not the same as that of or .
public static bool IsInRange(this IComparable value, IComparable limit1, IComparable limit2)
{
@@ -108,7 +109,7 @@
/// First range value.
/// Second range value.
/// The clipped value within the given validity range.
- /// Object type of
+ /// Thrown when object type of
/// is not the same as that of or .
public static T ClipValue(this T value, T limit1, T limit2) where T : IComparable
{
Index: Core/Common/src/Core.Common.Utils/FileUtils.cs
===================================================================
diff -u -r997937ce7659313e714efcd5fe47101c6b53d984 -rb7c2e788d70b36d8fdabb8b7f56e2184df85b550
--- Core/Common/src/Core.Common.Utils/FileUtils.cs (.../FileUtils.cs) (revision 997937ce7659313e714efcd5fe47101c6b53d984)
+++ Core/Common/src/Core.Common.Utils/FileUtils.cs (.../FileUtils.cs) (revision b7c2e788d70b36d8fdabb8b7f56e2184df85b550)
@@ -36,7 +36,7 @@
/// Validates the file path.
///
/// The file path to be validated.
- /// is invalid.
+ /// Thrown when is invalid.
/// A valid path:
///
/// - is not empty or null,
Index: Core/Common/src/Core.Common.Utils/IO/EmbeddedResourceFileWriter.cs
===================================================================
diff -u -r0d22462e91eb69208ab2aee6ed2c621d31006b02 -rb7c2e788d70b36d8fdabb8b7f56e2184df85b550
--- Core/Common/src/Core.Common.Utils/IO/EmbeddedResourceFileWriter.cs (.../EmbeddedResourceFileWriter.cs) (revision 0d22462e91eb69208ab2aee6ed2c621d31006b02)
+++ Core/Common/src/Core.Common.Utils/IO/EmbeddedResourceFileWriter.cs (.../EmbeddedResourceFileWriter.cs) (revision b7c2e788d70b36d8fdabb8b7f56e2184df85b550)
@@ -38,9 +38,12 @@
/// Initializes a new instance of the class.
///
/// The assembly that embeds the resources to write.
- /// Whether or not the files should be removed after disposing the created instance.
- /// The names of the Embedded Resource files to (temporary) write to the Windows Temp directory.
- /// An embedded resource file in cannot be found in .
+ /// Whether or not the files should be removed after
+ /// disposing the created instance.
+ /// The names of the Embedded Resource files to
+ /// (temporary) write to the Windows Temp directory.
+ /// Thrown when an embedded resource file in
+ /// cannot be found in .
public EmbeddedResourceFileWriter(Assembly assembly, bool removeFilesOnDispose, params string[] embeddedResourceFileNames)
{
this.removeFilesOnDispose = removeFilesOnDispose;
Index: Core/Common/src/Core.Common.Utils/Reflection/AssemblyUtils.cs
===================================================================
diff -u -r24da3aa72ccc0776599628c9f971081694048d9a -rb7c2e788d70b36d8fdabb8b7f56e2184df85b550
--- Core/Common/src/Core.Common.Utils/Reflection/AssemblyUtils.cs (.../AssemblyUtils.cs) (revision 24da3aa72ccc0776599628c9f971081694048d9a)
+++ Core/Common/src/Core.Common.Utils/Reflection/AssemblyUtils.cs (.../AssemblyUtils.cs) (revision b7c2e788d70b36d8fdabb8b7f56e2184df85b550)
@@ -93,8 +93,9 @@
/// Returns the type based on the full type name.
///
/// Full type name.
- /// The matching the string name, null otherwise.
- /// Specified type string is found in multiple assemblies.
+ /// The matching the string name, null otherwise.
+ /// Thrown when the specified type string is
+ /// found in multiple assemblies.
public static Type GetTypeByName(string typeName)
{
Type result = null;
@@ -122,8 +123,8 @@
/// The assembly from which to retrieve the embedded resource.
/// Name of the embedded file.
/// The byte-stream to the embedded resource.
- /// Embedded resource file with name
- /// cannot be found in .
+ /// Thrown when the embedded resource file with
+ /// name cannot be found in .
public static Stream GetAssemblyResourceStream(Assembly assembly, string fileName)
{
try
@@ -158,7 +159,7 @@
///
/// structure containing assembly attributes as strings.
///
- /// Values will be null if they were not specified.
+ /// Values will be null if they were not specified.
[Serializable]
public struct AssemblyInfo
{
Index: Core/Common/src/Core.Common.Utils/Reflection/TypeUtils.cs
===================================================================
diff -u -r24da3aa72ccc0776599628c9f971081694048d9a -rb7c2e788d70b36d8fdabb8b7f56e2184df85b550
--- Core/Common/src/Core.Common.Utils/Reflection/TypeUtils.cs (.../TypeUtils.cs) (revision 24da3aa72ccc0776599628c9f971081694048d9a)
+++ Core/Common/src/Core.Common.Utils/Reflection/TypeUtils.cs (.../TypeUtils.cs) (revision b7c2e788d70b36d8fdabb8b7f56e2184df85b550)
@@ -38,7 +38,7 @@
///
/// The type to check for.
/// Type to check.
- /// True if is the same type as ,
+ /// True if is the same type as ,
/// or has that as (one of) its supertypes.
///
public static bool Implements(this Type thisType)
@@ -51,7 +51,7 @@
///
/// Type to check.
/// The type to check for.
- /// True if is the same type as ,
+ /// True if is the same type as ,
/// or has that as (one of) its supertypes.
///
public static bool Implements(this Type thisType, Type type)
@@ -65,7 +65,7 @@
/// The type of the class on which the expression takes place.
/// The expression.
/// The string name of the member.
- /// When
+ /// Thrown when
/// is not an expression with a member, such as an expression calling multiple methods.
public static string GetMemberName(Expression> expression)
{
@@ -78,7 +78,7 @@
/// The type of the class on which the expression takes place.
/// The expression.
/// The string name of the member.
- /// When
+ /// Thrown when
/// is not an expression with a member, such as an expression calling multiple methods.
public static string GetMemberName(Expression> expression)
{
@@ -89,12 +89,12 @@
/// Gets the value of a field of an instance.
///
/// Type of the field.
- /// Instance holding the field. Cannot be null.
+ /// Instance holding the field. Cannot be null.
/// Name of the field.
/// The value of the field.
- /// When
+ /// Thrown when
/// doesn't have a field with the name .
- /// When is null.
+ /// Thrown when is null.
/// This method can be used for fields of any visibility.
public static T GetField(object instance, string fieldName)
{
@@ -110,13 +110,13 @@
///
/// Gets the value of a field of an instance.
///
- /// Instance holding the field. Cannot be null.
+ /// Instance holding the field. Cannot be null.
/// Name of the field.
/// The new value for the field.
- /// When
+ /// Thrown when
/// doesn't have a field with the name .
- /// is of incorrect type.
- /// When is null.
+ /// Thrown when is of incorrect type.
+ /// Thrown when is null.
/// This method can be used for fields of any visibility.
public static void SetField(object obj, string fieldName, object newValue)
{
@@ -133,20 +133,20 @@
/// Calls the private method that returns a value.
///
/// The return type of the method.
- /// The instance declaring the method. Cannot be null.
+ /// The instance declaring the method. Cannot be null.
/// Name of the method.
/// The arguments for the method.
- /// The method referred to by
+ /// Thrown when the method referred to by
/// is not declared or inherited by the class of .
- /// The invoked method or constructor throws an exception.
- /// The
+ /// Thrown when the invoked method or constructor throws an exception.
+ /// Thrown when the
/// array does not have the correct number of arguments.
/// The type that declares the method
/// is an open generic type. That is, the
- /// property returns true for the declaring type.
- /// More than one method is found with
+ /// property returns true for the declaring type.
+ /// Thrown when more than one method is found with
/// the specified name and matching the specified binding constraints.
- /// is null.
+ /// Thrown when is null.
/// The return value of the method.
public static T CallPrivateMethod(object instance, string methodName, params object[] arguments)
{
@@ -162,20 +162,20 @@
///
/// Calls the private method that without returning its value.
///
- /// The instance declaring the method. Cannot be null.
+ /// The instance declaring the method. Cannot be null.
/// Name of the method.
/// The arguments for the method.
- /// The method referred to by
+ /// Thrown when the method referred to by
/// is not declared or inherited by the class of .
- /// The invoked method or constructor throws an exception.
- /// The
+ /// Thrown when the invoked method or constructor throws an exception.
+ /// Thrown when the
/// array does not have the correct number of arguments.
- /// The type that declares the method
- /// is an open generic type. That is, the
- /// property returns true for the declaring type.
- /// More than one method is found with
+ /// Thrown when the type that declares the method
+ /// is an open generic type. I.e., the
+ /// property returns true for the declaring type.
+ /// Thrown when more than one method is found with
/// the specified name and matching the specified binding constraints.
- /// is null.
+ /// Thrown when is null.
public static void CallPrivateMethod(object instance, string methodName, params object[] arguments)
{
var methodInfo = instance.GetType().GetMethod(methodName, BindingFlags.NonPublic | BindingFlags.Instance);
@@ -190,15 +190,15 @@
///
/// Sets the value of a property with a setter.
///
- /// The instance declaring the property. Cannot be null.
+ /// The instance declaring the property. Cannot be null.
/// Name of the property to be set.
/// The new value of the property.
- /// is null.
- /// The property referred to by
+ /// Thrown when is null.
+ /// Thrown when the property referred to by
/// is not declared or inherited by the class of .
- /// The property has not setter.
- /// Property is an indexed property.
- /// An error occurred while setting the
+ /// Thrown when the property has not setter.
+ /// Thrown when the Property is an indexed property.
+ /// Thrown when an error occurred while setting the
/// property value. For example, an index value specified for an indexed property
/// is out of range. The property indicates
/// the reason for the error.
@@ -223,12 +223,12 @@
/// The expression that resolves to the property to be checked.
/// True if the property is decorated with the given ,
/// false otherwise.
- /// When
+ /// Thrown when
/// is not an expression with a property, such as an expression calling multiple methods.
- /// More then one property is found with
+ /// Thrown when more then one property is found with
/// name specified in .
- /// A custom attribute type cannot be loaded.
- /// The property in
+ /// Thrown when a custom attribute type cannot be loaded.
+ /// Thrown when the property in
/// belongs to a type that is loaded into the reflection-only context. See How to:
/// Load Assemblies into the Reflection-Only Context on MSDN for more information.
public static bool HasTypeConverter(Expression> expression) where TTypeConverter : TypeConverter
@@ -299,9 +299,9 @@
///
/// Declaring type of the field.
/// Name of the field.
- /// A object capturing the requested field, or null
+ /// A object capturing the requested field, or null
/// if the field cannot be found in .
- /// is null.
+ /// Thrown when is null.
private static FieldInfo GetFieldInfo(Type type, string fieldName)
{
if (type == typeof(object) || type == null)
Index: Core/Common/test/Core.Common.Utils.Test/Reflection/AssemblyUtilsTest.cs
===================================================================
diff -u -rf60662cc8bcf55ea16dec82ebc17bfe3e7356f71 -rb7c2e788d70b36d8fdabb8b7f56e2184df85b550
--- Core/Common/test/Core.Common.Utils.Test/Reflection/AssemblyUtilsTest.cs (.../AssemblyUtilsTest.cs) (revision f60662cc8bcf55ea16dec82ebc17bfe3e7356f71)
+++ Core/Common/test/Core.Common.Utils.Test/Reflection/AssemblyUtilsTest.cs (.../AssemblyUtilsTest.cs) (revision b7c2e788d70b36d8fdabb8b7f56e2184df85b550)
@@ -57,7 +57,7 @@
}
[Test]
- public void GetAssemblyInfo_ForThisTestProjectAssmebly_ReturnAssmeblyInfoWithExpectedValues()
+ public void GetAssemblyInfo_ForThisTestProjectAssembly_ReturnAssemblyInfoWithExpectedValues()
{
// Setup
Assembly assembly = Assembly.GetAssembly(GetType());
@@ -75,7 +75,7 @@
}
[Test]
- public void GetExecutingAssemblyInfo_ReturnAssmeblyInfoForAssemblyUtilsAssembly()
+ public void GetExecutingAssemblyInfo_ReturnAssemblyInfoForAssemblyUtilsAssembly()
{
// Setup
Assembly assembly = Assembly.GetAssembly(typeof(AssemblyUtils));