Skip to content

Port the doc changes to source #72638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tarekgh merged 6 commits into from
Jul 22, 2022
Merged

Port the doc changes to source #72638

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6bf0f9e
Port the doc changes to source
tarekgh Jul 21, 2022
1edb343
Address the feedback
tarekgh Jul 21, 2022
561f684
Update src/libraries/System.ComponentModel.TypeConverter/src/System/C…
tarekgh Jul 21, 2022
bf7969d
Remove duplicated summary section
tarekgh Jul 21, 2022
b2b1c8f
reorder the doc elements
tarekgh Jul 21, 2022
e22932c
reorder the remaining doc elements
tarekgh Jul 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions ...raries/System.ComponentModel.TypeConverter/src/System/ComponentModel/DateOnlyConverter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@
namespace System.ComponentModel
{
/// <summary>
/// Provides a type converter to convert <see cref='System.DateOnly'/>
/// objects to and from various other representations.
/// Provides a type converter to convert <see cref='System.DateOnly'/> objects to and from various other representations.
/// </summary>
public class DateOnlyConverter : TypeConverter
{
Expand All @@ -19,6 +18,9 @@ public class DateOnlyConverter : TypeConverter
/// object in the given source type to a <see cref='System.DateOnly'/>
/// object using the specified context.
/// </summary>
/// <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
/// <param name="sourceType">The type to convert from.</param>
/// <returns><see langword="true" /> if this object can perform the conversion; otherwise, <see langword="false" />.</returns>
public override bool CanConvertFrom(ITypeDescriptorContext? context, Type sourceType)
{
return sourceType == typeof(string) || base.CanConvertFrom(context, sourceType);
Expand All @@ -28,6 +30,9 @@ public override bool CanConvertFrom(ITypeDescriptorContext? context, Type source
/// Gets a value indicating whether this converter can convert an object
/// to the given destination type using the context.
/// </summary>
/// <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
/// <param name="destinationType">The type to convert to.</param>
/// <returns><see langword="true" /> if this converter can perform the conversion; otherwise, <see langword="false" />.</returns>
public override bool CanConvertTo(ITypeDescriptorContext? context, [NotNullWhen(true)] Type? destinationType)
{
return destinationType == typeof(InstanceDescriptor) || base.CanConvertTo(context, destinationType);
Expand All @@ -36,6 +41,10 @@ public override bool CanConvertTo(ITypeDescriptorContext? context, [NotNullWhen(
/// <summary>
/// Converts the given value object to a <see cref='System.DateOnly'/> object.
/// </summary>
/// <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
/// <param name="culture">An optional <see cref="T:System.Globalization.CultureInfo" />. If not supplied, the current culture is assumed.</param>
/// <param name="value">The <see cref="T:System.Object" /> to convert.</param>
/// <returns>An <see cref="T:System.Object" /> that represents the converted <paramref name="value" />.</returns>
public override object? ConvertFrom(ITypeDescriptorContext? context, CultureInfo? culture, object value)
{
if (value is string text)
Expand Down Expand Up @@ -77,6 +86,11 @@ public override bool CanConvertTo(ITypeDescriptorContext? context, [NotNullWhen(
/// <summary>
/// Converts the given value object from a <see cref='System.DateOnly'/> object using the arguments.
/// </summary>
/// <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
/// <param name="culture">An optional <see cref="T:System.Globalization.CultureInfo" />. If not supplied, the current culture is assumed.</param>
/// <param name="value">The <see cref="T:System.Object" /> to convert.</param>
/// <param name="destinationType">The <see cref="T:System.Type" /> to convert the value to.</param>
/// <returns>An <see cref="T:System.Object" /> that represents the converted <paramref name="value" />.</returns>
public override object? ConvertTo(ITypeDescriptorContext? context, CultureInfo? culture, object? value, Type destinationType)
{
if (destinationType == typeof(string) && value is DateOnly dateOnly)
Expand Down
18 changes: 16 additions & 2 deletions ...raries/System.ComponentModel.TypeConverter/src/System/ComponentModel/TimeOnlyConverter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@
namespace System.ComponentModel
{
/// <summary>
/// Provides a type converter to convert <see cref='System.TimeOnly'/>
/// objects to and from various other representations.
/// Provides a type converter to convert <see cref='System.TimeOnly'/> objects to and from various other representations.
/// </summary>
public class TimeOnlyConverter : TypeConverter
{
Expand All @@ -19,6 +18,9 @@ public class TimeOnlyConverter : TypeConverter
/// object in the given source type to a <see cref='System.TimeOnly'/>
/// object using the specified context.
/// </summary>
/// <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
/// <param name="sourceType">The type to convert from.</param>
/// <returns><see langword="true" /> if this object can perform the conversion; otherwise, <see langword="false" />.</returns>
public override bool CanConvertFrom(ITypeDescriptorContext? context, Type sourceType)
{
return sourceType == typeof(string) || base.CanConvertFrom(context, sourceType);
Expand All @@ -28,6 +30,9 @@ public override bool CanConvertFrom(ITypeDescriptorContext? context, Type source
/// Gets a value indicating whether this converter can convert an object
/// to the given destination type using the context.
/// </summary>
/// <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
/// <param name="destinationType">The type to convert to.</param>
/// <returns><see langword="true" /> if this converter can perform the conversion; otherwise, <see langword="false" />.</returns>
public override bool CanConvertTo(ITypeDescriptorContext? context, [NotNullWhen(true)] Type? destinationType)
{
return destinationType == typeof(InstanceDescriptor) || base.CanConvertTo(context, destinationType);
Expand All @@ -36,6 +41,10 @@ public override bool CanConvertTo(ITypeDescriptorContext? context, [NotNullWhen(
/// <summary>
/// Converts the given value object to a <see cref='System.TimeOnly'/> object.
/// </summary>
/// <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
/// <param name="culture">An optional <see cref="T:System.Globalization.CultureInfo" />. If not supplied, the current culture is assumed.</param>
/// <param name="value">The <see cref="T:System.Object" /> to convert.</param>
/// <returns>An <see cref="T:System.Object" /> that represents the converted <paramref name="value" />.</returns>
public override object? ConvertFrom(ITypeDescriptorContext? context, CultureInfo? culture, object value)
{
if (value is string text)
Expand Down Expand Up @@ -77,6 +86,11 @@ public override bool CanConvertTo(ITypeDescriptorContext? context, [NotNullWhen(
/// <summary>
/// Converts the given value object from a <see cref='System.TimeOnly'/> object using the arguments.
/// </summary>
/// <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
/// <param name="culture">An optional <see cref="T:System.Globalization.CultureInfo" />. If not supplied, the current culture is assumed.</param>
/// <param name="value">The <see cref="T:System.Object" /> to convert.</param>
/// <param name="destinationType">The <see cref="T:System.Type" /> to convert the value to.</param>
/// <returns>An <see cref="T:System.Object" /> that represents the converted <paramref name="value" />.</returns>
public override object? ConvertTo(ITypeDescriptorContext? context, CultureInfo? culture, object? value, Type destinationType)
{
if (destinationType == typeof(string) && value is TimeOnly timeOnly)
Expand Down