P0
/
MapTo
3
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentations.

This commit is contained in:
Mohammadreza Taikandi 2021-02-21 08:18:19 +00:00
parent c1a763a474
commit 243f2e6b75
6 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/MapTo/Sources/ITypeConverterSource.cs
View File

@ -23,7 +23,7 @@ namespace MapTo.Sources
{
builder
.WriteLine("/// <summary>")
.WriteLine("/// Converts the value of <typeparamref name=\"TSource\"/> <typeparamref name=\"TDestination\"/>.")
.WriteLine("/// Converts the value of <typeparamref name=\"TSource\"/> to <typeparamref name=\"TDestination\"/>.")
.WriteLine("/// </summary>")
.WriteLine("/// <typeparam name=\"TSource\">The type to convert from.</typeparam>")
.WriteLine("/// <typeparam name=\"TDestination\">The type to convert to.</typeparam>");

2
src/MapTo/Sources/IgnorePropertyAttributeSource.cs
View File

@ -21,7 +21,7 @@ namespace MapTo.Sources
{
builder
.WriteLine("/// <summary>")
.WriteLine("/// Specified that the annotated property should not be included in the generated mappings.")
.WriteLine("/// Specifies that the annotated property should be excluded.")
.WriteLine("/// </summary>");
}

2
src/MapTo/Sources/MapClassSource.cs
View File

@ -123,7 +123,7 @@ namespace MapTo.Sources
.WriteLine($"/// Creates a new instance of <see cref=\"{model.ClassName}\"/> and sets its participating properties")
.WriteLine($"/// using the property values from <paramref name=\"{sourceClassParameterName}\"/>.")
.WriteLine("/// </summary>")
.WriteLine($"/// <param name=\"{sourceClassParameterName}\">Instance of <see cref=\"{model.SourceClassName}\"/> to use as source.</param>")
.WriteLine($"/// <param name=\"{sourceClassParameterName}\">The instance of <see cref=\"{model.SourceClassName}\"/> to use as source.</param>")
.WriteLine($"/// <returns>A new instance of <see cred=\"{model.ClassName}\"/> -or- <c>null</c> if <paramref name=\"{sourceClassParameterName}\"/> is <c>null</c>.</returns>");
}

5
src/MapTo/Sources/MapFromAttributeSource.cs
View File

@ -35,7 +35,8 @@ namespace MapTo.Sources
builder
.WriteLine("/// <summary>")
.WriteLine($"/// Initializes a new instance of the <see cref=\"{AttributeName}Attribute\"/> class with the specified <paramref name=\"sourceType\"/>.")
.WriteLine("/// </summary>");
.WriteLine("/// </summary>")
.WriteLine("/// <param name=\"sourceType\">The type of to map from.</param>");
}
builder
@ -49,7 +50,7 @@ namespace MapTo.Sources
{
builder
.WriteLine("/// <summary>")
.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("/// </summary>");
}

2
src/MapTo/Sources/MapPropertyAttributeSource.cs
View File

@ -24,7 +24,7 @@ namespace MapTo.Sources
{
builder
.WriteLine("/// <summary>")
.WriteLine("/// Specifies the mapping behavior of annotated property.")
.WriteLine("/// Specifies the mapping behavior of the annotated property.")
.WriteLine("/// </summary>")
.WriteLine("/// <remarks>")
.WriteLine($"/// {AttributeClassName} has a number of uses:")

4
src/MapTo/Sources/MapTypeConverterAttributeSource.cs
View File

@ -42,7 +42,7 @@ namespace MapTo.Sources
.WriteLine($"/// Initializes a new instance of <see cref=\"{AttributeClassName}\"/>.")
.WriteLine("/// </summary>")
.WriteLine($"/// <param name=\"converter\">The <see cref=\"{ITypeConverterSource.InterfaceName}{{TSource,TDestination}}\" /> to be used to convert the source type.</param>")
.WriteLine("/// <param name=\"converterParameters\">The parameter list to pass to the <paramref name=\"converter\"/> during the type conversion.</param>");
.WriteLine("/// <param name=\"converterParameters\">The list of parameters to pass to the <paramref name=\"converter\"/> during the type conversion.</param>");
}
builder
@ -69,7 +69,7 @@ namespace MapTo.Sources
{
builder
.WriteLine("/// <summary>")
.WriteLine($"/// Gets the parameter list to pass to the <see cref=\"{ConverterPropertyName}\"/> during the type conversion.")
.WriteLine($"/// Gets the list of parameters to pass to the <see cref=\"{ConverterPropertyName}\"/> during the type conversion.")
.WriteLine("/// </summary>");
}