From 243f2e6b7588f579793d9faf53ba9b28621f03e3 Mon Sep 17 00:00:00 2001 From: Mohammadreza Taikandi Date: Sun, 21 Feb 2021 08:18:19 +0000 Subject: [PATCH] Update documentations. --- src/MapTo/Sources/ITypeConverterSource.cs | 2 +- src/MapTo/Sources/IgnorePropertyAttributeSource.cs | 2 +- src/MapTo/Sources/MapClassSource.cs | 2 +- src/MapTo/Sources/MapFromAttributeSource.cs | 5 +++-- src/MapTo/Sources/MapPropertyAttributeSource.cs | 2 +- src/MapTo/Sources/MapTypeConverterAttributeSource.cs | 4 ++-- 6 files changed, 9 insertions(+), 8 deletions(-) diff --git a/src/MapTo/Sources/ITypeConverterSource.cs b/src/MapTo/Sources/ITypeConverterSource.cs index b93d9cc..3b627b8 100644 --- a/src/MapTo/Sources/ITypeConverterSource.cs +++ b/src/MapTo/Sources/ITypeConverterSource.cs @@ -23,7 +23,7 @@ namespace MapTo.Sources { builder .WriteLine("/// ") - .WriteLine("/// Converts the value of .") + .WriteLine("/// Converts the value of to .") .WriteLine("/// ") .WriteLine("/// The type to convert from.") .WriteLine("/// The type to convert to."); diff --git a/src/MapTo/Sources/IgnorePropertyAttributeSource.cs b/src/MapTo/Sources/IgnorePropertyAttributeSource.cs index 03a8b79..a770d22 100644 --- a/src/MapTo/Sources/IgnorePropertyAttributeSource.cs +++ b/src/MapTo/Sources/IgnorePropertyAttributeSource.cs @@ -21,7 +21,7 @@ namespace MapTo.Sources { builder .WriteLine("/// ") - .WriteLine("/// Specified that the annotated property should not be included in the generated mappings.") + .WriteLine("/// Specifies that the annotated property should be excluded.") .WriteLine("/// "); } diff --git a/src/MapTo/Sources/MapClassSource.cs b/src/MapTo/Sources/MapClassSource.cs index ae97ad7..3aa5f9b 100644 --- a/src/MapTo/Sources/MapClassSource.cs +++ b/src/MapTo/Sources/MapClassSource.cs @@ -123,7 +123,7 @@ namespace MapTo.Sources .WriteLine($"/// Creates a new instance of and sets its participating properties") .WriteLine($"/// using the property values from .") .WriteLine("/// ") - .WriteLine($"/// Instance of to use as source.") + .WriteLine($"/// The instance of to use as source.") .WriteLine($"/// A new instance of -or- null if is null."); } diff --git a/src/MapTo/Sources/MapFromAttributeSource.cs b/src/MapTo/Sources/MapFromAttributeSource.cs index f4a54d3..fc3f52b 100644 --- a/src/MapTo/Sources/MapFromAttributeSource.cs +++ b/src/MapTo/Sources/MapFromAttributeSource.cs @@ -35,7 +35,8 @@ namespace MapTo.Sources builder .WriteLine("/// ") .WriteLine($"/// Initializes a new instance of the class with the specified .") - .WriteLine("/// "); + .WriteLine("/// ") + .WriteLine("/// The type of to map from."); } builder @@ -49,7 +50,7 @@ namespace MapTo.Sources { builder .WriteLine("/// ") - .WriteLine("/// Gets the type of the class that the annotated class should be able to map from.") + .WriteLine("/// Gets the type to map from.") .WriteLine("/// "); } diff --git a/src/MapTo/Sources/MapPropertyAttributeSource.cs b/src/MapTo/Sources/MapPropertyAttributeSource.cs index dacdbfc..3012223 100644 --- a/src/MapTo/Sources/MapPropertyAttributeSource.cs +++ b/src/MapTo/Sources/MapPropertyAttributeSource.cs @@ -24,7 +24,7 @@ namespace MapTo.Sources { builder .WriteLine("/// ") - .WriteLine("/// Specifies the mapping behavior of annotated property.") + .WriteLine("/// Specifies the mapping behavior of the annotated property.") .WriteLine("/// ") .WriteLine("/// ") .WriteLine($"/// {AttributeClassName} has a number of uses:") diff --git a/src/MapTo/Sources/MapTypeConverterAttributeSource.cs b/src/MapTo/Sources/MapTypeConverterAttributeSource.cs index 04caf0f..6852549 100644 --- a/src/MapTo/Sources/MapTypeConverterAttributeSource.cs +++ b/src/MapTo/Sources/MapTypeConverterAttributeSource.cs @@ -42,7 +42,7 @@ namespace MapTo.Sources .WriteLine($"/// Initializes a new instance of .") .WriteLine("/// ") .WriteLine($"/// The to be used to convert the source type.") - .WriteLine("/// The parameter list to pass to the during the type conversion."); + .WriteLine("/// The list of parameters to pass to the during the type conversion."); } builder @@ -69,7 +69,7 @@ namespace MapTo.Sources { builder .WriteLine("/// ") - .WriteLine($"/// Gets the parameter list to pass to the during the type conversion.") + .WriteLine($"/// Gets the list of parameters to pass to the during the type conversion.") .WriteLine("/// "); }