diff options
| author | Miguel de Icaza <miguel@gnome.org> | 2014-05-15 22:48:07 +0400 |
|---|---|---|
| committer | Miguel de Icaza <miguel@gnome.org> | 2014-05-15 22:48:07 +0400 |
| commit | 3cd9b7e003fc1899d6bc91a5cfc898d8015ef32b (patch) | |
| tree | 9ffb293e8fd22f12df47b5abab46828dc6b720e2 /mcs/class/System.ComponentModel.DataAnnotations | |
| parent | 563a83943ed26fcfbdd4cf95dbb6b4a3d52e0a76 (diff) | |
| parent | e9068ebf5b5237e95ba5924bd978c5d119f8290c (diff) | |
Merge pull request #1034 from joelmartinez/msdoc-import2
Second pass of Microsoft Documentation import
Diffstat (limited to 'mcs/class/System.ComponentModel.DataAnnotations')
25 files changed, 325 insertions, 94 deletions
diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/AssociatedMetadataTypeTypeDescriptionProvider.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/AssociatedMetadataTypeTypeDescriptionProvider.xml index 00dd945b260..c1e324f669d 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/AssociatedMetadataTypeTypeDescriptionProvider.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/AssociatedMetadataTypeTypeDescriptionProvider.xml @@ -79,12 +79,15 @@ <Parameter Name="instance" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Gets a type descriptor for the specified type and object.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The descriptor that provides metadata for the type.</para> + </returns> <param name="objectType"> <attribution license="cc4" from="Microsoft" modified="false" />The type of object to retrieve the type descriptor for.</param> <param name="instance"> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/CompareAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/CompareAttribute.xml index 6b544da3d9d..beb6d3a3d9a 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/CompareAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/CompareAttribute.xml @@ -57,12 +57,15 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Applies formatting to an error message, based on the data field where the error occurred.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The formatted error message.</para> + </returns> <param name="name"> <attribution license="cc4" from="Microsoft" modified="false" />The name of the field that caused the validation failure.</param> </Docs> @@ -83,12 +86,15 @@ </Parameters> <Docs> <param name="context">To be added.</param> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Determines whether a specified object is valid.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if <paramref name="value" /> is valid; otherwise, false.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The object to validate.</param> </Docs> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/CreditCardAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/CreditCardAttribute.xml index 8934a5756c2..3a436539b7d 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/CreditCardAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/CreditCardAttribute.xml @@ -56,7 +56,6 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>The value is validated using a regular expression. The class does not validate that the credit card number is valid for purchases, only that it is well formed.</para> @@ -65,6 +64,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Determines whether the specified credit card number is valid. </para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the credit card number is valid; otherwise, false.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The value to validate.</param> </Docs> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/CustomValidationAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/CustomValidationAttribute.xml index df7341ccce7..277526a3e48 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/CustomValidationAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/CustomValidationAttribute.xml @@ -68,7 +68,6 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>The error message is formatted at run time to include the <paramref name="name" /> value that is passed to this method.</para> @@ -77,6 +76,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Formats a validation error message.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An instance of the formatted error message.</para> + </returns> <param name="name"> <attribution license="cc4" from="Microsoft" modified="false" />The name to include in the formatted message.</param> </Docs> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/DataTypeAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/DataTypeAttribute.xml index 50a5064c06d..cbbf0dc561f 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/DataTypeAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/DataTypeAttribute.xml @@ -164,7 +164,6 @@ </ReturnValue> <Parameters /> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>The name of the type that is associated with the data field.</para> @@ -173,6 +172,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Returns the name of the type that is associated with the data field.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The name of the type associated with the data field.</para> + </returns> </Docs> </Member> <Member MemberName="IsValid"> @@ -189,7 +192,6 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>This method implements validation logic that is specific to the <see cref="T:System.ComponentModel.DataAnnotations.DataTypeAttribute" /> attribute.</para> @@ -198,6 +200,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Checks that the value of the data field is valid.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true always.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The data field value to validate.</param> </Docs> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/DisplayAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/DisplayAttribute.xml index 16c8f19be46..daf7307c29a 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/DisplayAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/DisplayAttribute.xml @@ -125,12 +125,15 @@ </ReturnValue> <Parameters /> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Returns the value of the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.AutoGenerateField" /> property.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The value of <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.AutoGenerateField" /> if the property has been initialized; otherwise, null.</para> + </returns> </Docs> </Member> <Member MemberName="GetAutoGenerateFilter"> @@ -145,12 +148,15 @@ </ReturnValue> <Parameters /> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Returns a value that indicates whether UI should be generated automatically in order to display filtering for this field. </para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The value of <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.AutoGenerateFilter" /> if the property has been initialized; otherwise, null.</para> + </returns> </Docs> </Member> <Member MemberName="GetDescription"> @@ -165,7 +171,6 @@ </ReturnValue> <Parameters /> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>The <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Description" /> property is typically used as a tooltip for the property that is annotated with this attribute.</para> @@ -174,6 +179,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Returns the value of the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Description" /> property.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The localized description, if the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.ResourceType" /> has been specified and the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Description" /> property represents a resource key; otherwise, the non-localized value of the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Description" /> property.</para> + </returns> </Docs> </Member> <Member MemberName="GetGroupName"> @@ -188,12 +197,15 @@ </ReturnValue> <Parameters /> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Returns the value of the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.GroupName" /> property.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A value that will be used for grouping fields in the UI, if <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.GroupName" /> has been initialized; otherwise, null. If the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.ResourceType" /> property has been specified and the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.GroupName" /> property represents a resource key, a localized string is returned; otherwise, a non-localized string is returned.</para> + </returns> </Docs> </Member> <Member MemberName="GetName"> @@ -208,7 +220,6 @@ </ReturnValue> <Parameters /> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>The name is typically used as the field label for a UI element that is bound to the property that is annotated with the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Name" /> property. A null value or empty string is valid.</para> @@ -217,6 +228,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Returns a value that is used for field display in the UI.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The localized string for the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Name" /> property, if the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.ResourceType" /> property has been specified and the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Name" /> property represents a resource key; otherwise, the non-localized value of the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Name" /> property.</para> + </returns> </Docs> </Member> <Member MemberName="GetOrder"> @@ -231,7 +246,6 @@ </ReturnValue> <Parameters /> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>If an order is not specified, presentation layers should consider setting the value of the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Order" /> property to 10000. This value lets explicitly-ordered fields be displayed before and after the fields that do not have a specified order.</para> @@ -240,6 +254,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Returns the value of the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Order" /> property.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The value of the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Order" /> property, if it has been set; otherwise, null.</para> + </returns> </Docs> </Member> <Member MemberName="GetPrompt"> @@ -254,7 +272,6 @@ </ReturnValue> <Parameters /> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>The <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Prompt" /> property is typically used as a prompt or watermark for a UI element that is bound to the property that is annotated with the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Prompt" /> attribute.</para> @@ -263,6 +280,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Returns the value of the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Prompt" /> property.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the localized string for the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Prompt" /> property if the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.ResourceType" /> property has been specified and if the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Prompt" /> property represents a resource key; otherwise, the non-localized value of the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Prompt" /> property.</para> + </returns> </Docs> </Member> <Member MemberName="GetShortName"> @@ -277,7 +298,6 @@ </ReturnValue> <Parameters /> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>The short name is used as the grid column label for a UI element that is bound to the property that is annotated with this attribute. This property returns either the literal, non-localized string, or a localized string if <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.ResourceType" /> is not null.</para> @@ -286,6 +306,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Returns the value of the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.ShortName" /> property.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The localized string for the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.ShortName" /> property if the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.ResourceType" /> property has been specified and if the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.ShortName" /> property represents a resource key; otherwise, the non-localized value of the <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.ShortName" /> value property.</para> + </returns> </Docs> </Member> <Member MemberName="GroupName"> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/EmailAddressAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/EmailAddressAttribute.xml index 3a05f94ed67..2f1e05a75be 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/EmailAddressAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/EmailAddressAttribute.xml @@ -53,12 +53,15 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Determines whether the specified value matches the pattern of a valid email address.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the specified value is valid or null; otherwise, false.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The value to validate.</param> </Docs> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/EnumDataTypeAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/EnumDataTypeAttribute.xml index 3d8a95a6f18..87d86fde8cf 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/EnumDataTypeAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/EnumDataTypeAttribute.xml @@ -79,12 +79,15 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Checks that the value of the data field is valid.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the data field value is valid; otherwise, false.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The data field value to validate.</param> </Docs> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/FileExtensionsAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/FileExtensionsAttribute.xml index e9942ae3d7d..57a44e8e9ca 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/FileExtensionsAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/FileExtensionsAttribute.xml @@ -72,12 +72,15 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Applies formatting to an error message, based on the data field where the error occurred.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The formatted error message.</para> + </returns> <param name="name"> <attribution license="cc4" from="Microsoft" modified="false" />The name of the field that caused the validation failure.</param> </Docs> @@ -96,12 +99,15 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Checks that the specified file name extension or extensions is valid.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the file name extension is valid; otherwise, false.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />A comma delimited list of valid file extensions.</param> </Docs> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/FilterUIHintAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/FilterUIHintAttribute.xml index 9129035994b..244bc9fde3d 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/FilterUIHintAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/FilterUIHintAttribute.xml @@ -131,12 +131,17 @@ <Parameter Name="obj" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Returns a value that indicates whether this attribute instance is equal to a specified object.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para /> + <para>True if the passed object is equal to this attribute instance; otherwise, false.</para> + <para /> + </returns> <param name="obj"> <attribution license="cc4" from="Microsoft" modified="false" />The object to compare with this attribute instance.</param> </Docs> @@ -172,12 +177,17 @@ </ReturnValue> <Parameters /> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Returns the hash code for this attribute instance.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para /> + <para>This attribute insatnce hash code.</para> + <para /> + </returns> </Docs> </Member> <Member MemberName="PresentationLayer"> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/IValidatableObject.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/IValidatableObject.xml index 042a4355ece..118358ae61e 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/IValidatableObject.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/IValidatableObject.xml @@ -29,12 +29,15 @@ <Parameter Name="validationContext" Type="System.ComponentModel.DataAnnotations.ValidationContext" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Determines whether the specified object is valid.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A collection that holds failed-validation information.</para> + </returns> <param name="validationContext"> <attribution license="cc4" from="Microsoft" modified="false" />The validation context.</param> </Docs> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/MaxLengthAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/MaxLengthAttribute.xml index 2f28ec37370..4ca25269ea9 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/MaxLengthAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/MaxLengthAttribute.xml @@ -76,12 +76,15 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Applies formatting to a specified error message.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A localized string to describe the maximum acceptable length.</para> + </returns> <param name="name"> <attribution license="cc4" from="Microsoft" modified="false" />The name to include in the formatted string.</param> </Docs> @@ -100,7 +103,6 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>This method returns true if the <paramref name="value" /> parameter is null.</para> @@ -109,6 +111,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Determines whether a specified object is valid.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the value is null, or if the value is less than or equal to the specified maximum length; otherwise, false.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The object to validate.</param> </Docs> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/MinLengthAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/MinLengthAttribute.xml index 4d8e4b69e07..8035eb86686 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/MinLengthAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/MinLengthAttribute.xml @@ -70,12 +70,15 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Applies formatting to a specified error message.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A localized string to describe the minimum acceptable length.</para> + </returns> <param name="name"> <attribution license="cc4" from="Microsoft" modified="false" />The name to include in the formatted string.</param> </Docs> @@ -94,12 +97,15 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Determines whether a specified object is valid.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the specified object is valid; otherwise, false.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The object to validate.</param> </Docs> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/PhoneAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/PhoneAttribute.xml index 3ec6714a17b..2122480e0d7 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/PhoneAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/PhoneAttribute.xml @@ -53,12 +53,15 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Determines whether the specified phone number is in a valid phone number format. </para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the phone number is valid; otherwise, false.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The value to validate.</param> </Docs> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/RangeAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/RangeAttribute.xml index 1283065f25d..860a673f969 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/RangeAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/RangeAttribute.xml @@ -115,7 +115,6 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>The <see cref="M:System.ComponentModel.DataAnnotations.RangeAttribute.FormatErrorMessage(System.String)" /> creates the error message by using the name of the data field that caused the validation failure. You can override this method in a custom validation attribute to customize how errors are created, or to provide a more complex message that contains parameters that you evaluate at run time. For an example, see the <see cref="M:System.ComponentModel.DataAnnotations.RangeAttribute.#ctor(System.Type,System.String,System.String)" /> constructor.</para> @@ -124,6 +123,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Formats the error message that is displayed when range validation fails.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The formatted error message.</para> + </returns> <param name="name"> <attribution license="cc4" from="Microsoft" modified="false" />The name of the field that caused the validation failure. </param> </Docs> @@ -142,12 +145,15 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Checks that the value of the data field is in the specified range.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the specified value is in the range; otherwise, false.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The data field value to validate.</param> </Docs> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/RegularExpressionAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/RegularExpressionAttribute.xml index f498cd80f2e..eb482670c50 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/RegularExpressionAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/RegularExpressionAttribute.xml @@ -60,7 +60,6 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>The <see cref="M:System.ComponentModel.DataAnnotations.RegularExpressionAttribute.FormatErrorMessage(System.String)" /> creates the error message by using the name of the data field that caused the validation failure. You can override this method in custom validation attributes to customize how errors are created or to provide a more complex message that contains parameters that you evaluate at run time. </para> @@ -69,6 +68,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Formats the error message to display if the regular expression validation fails.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The formatted error message.</para> + </returns> <param name="name"> <attribution license="cc4" from="Microsoft" modified="false" />The name of the field that caused the validation failure.</param> </Docs> @@ -87,12 +90,15 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Checks whether the value entered by the user matches the regular expression pattern. </para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if validation is successful; otherwise, false.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The data field value to validate.</param> </Docs> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/RequiredAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/RequiredAttribute.xml index 5c478b101d3..3dece32de1f 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/RequiredAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/RequiredAttribute.xml @@ -83,7 +83,6 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>If the value is an empty string, the method returns false and a validation error is displayed.</para> @@ -92,6 +91,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Checks that the value of the required data field is not empty.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if validation is successful; otherwise, false.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The data field value to validate.</param> </Docs> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/StringLengthAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/StringLengthAttribute.xml index ff788922001..0223bb51b52 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/StringLengthAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/StringLengthAttribute.xml @@ -60,12 +60,15 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Applies formatting to a specified error message.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The formatted error message.</para> + </returns> <param name="name"> <attribution license="cc4" from="Microsoft" modified="false" />The name of the field that caused the validation failure.</param> </Docs> @@ -84,7 +87,6 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>This method determines whether an object is valid. If the value of the object is null, the method automatically validates object. </para> @@ -93,6 +95,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Determines whether a specified object is valid.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the specified object is valid; otherwise, false.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The object to validate.</param> </Docs> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/UIHintAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/UIHintAttribute.xml index 425545390cd..df3d7153f49 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/UIHintAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/UIHintAttribute.xml @@ -143,12 +143,15 @@ <Parameter Name="obj" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Gets a value that indicates whether this instance is equal to the specified object.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the specified object is equal to this instance; otherwise, false.</para> + </returns> <param name="obj"> <attribution license="cc4" from="Microsoft" modified="false" />The object to compare with this instance, or a null reference.</param> </Docs> @@ -165,12 +168,15 @@ </ReturnValue> <Parameters /> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Gets the hash code for the current instance of the attribute.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The attribute instance hash code.</para> + </returns> </Docs> </Member> <Member MemberName="PresentationLayer"> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/ValidationAttribute.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/ValidationAttribute.xml index b648290ddda..d579c6eecad 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/ValidationAttribute.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/ValidationAttribute.xml @@ -48,9 +48,16 @@ <Parameter Name="errorMessageAccessor" Type="System.Func<System.String>" /> </Parameters> <Docs> - <param name="errorMessageAccessor">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This constructor provides a resource accessor function that is used by the <see cref="P:System.ComponentModel.DataAnnotations.ValidationAttribute.ErrorMessageString" /> property to retrieve an error message. </para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.DataAnnotations.ValidationAttribute" /> class by using the function that enables access to validation resources.</para> + </summary> + <param name="errorMessageAccessor"> + <attribution license="cc4" from="Microsoft" modified="false" />The function that enables access to validation resources.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -175,7 +182,6 @@ <Parameter Name="name" Type="System.String" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>This method formats an error message by using the <see cref="P:System.ComponentModel.DataAnnotations.ValidationAttribute.ErrorMessageString" /> property. This method appends the name of the data field that triggered the error to the formatted error message. You can customize how the error message is formatted by creating a derived class that overrides this method.</para> @@ -184,6 +190,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Applies formatting to an error message, based on the data field where the error occurred. </para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An instance of the formatted error message.</para> + </returns> <param name="name"> <attribution license="cc4" from="Microsoft" modified="false" />The name to include in the formatted message.</param> </Docs> @@ -203,7 +213,6 @@ <Parameter Name="validationContext" Type="System.ComponentModel.DataAnnotations.ValidationContext" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>The <see cref="M:System.ComponentModel.DataAnnotations.ValidationAttribute.GetValidationResult(System.Object,System.ComponentModel.DataAnnotations.ValidationContext)" /> method checks validity without throwing an exception.</para> @@ -212,6 +221,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Checks whether the specified value is valid with respect to the current validation attribute.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An instance of the <see cref="T:System.ComponentModel.DataAnnotations.ValidationResult" /> class. </para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The value to validate.</param> <param name="validationContext"> @@ -232,7 +245,6 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>If you inherit from the <see cref="T:System.ComponentModel.DataAnnotations.ValidationAttribute" /> class, you must implement the validation logic in this method.</para> @@ -241,6 +253,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Determines whether the specified value of the object is valid. </para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the specified value is valid; otherwise, false.</para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The value of the object to validate. </param> </Docs> @@ -260,12 +276,15 @@ <Parameter Name="validationContext" Type="System.ComponentModel.DataAnnotations.ValidationContext" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Validates the specified value with respect to the current validation attribute.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An instance of the <see cref="T:System.ComponentModel.DataAnnotations.ValidationResult" /> class. </para> + </returns> <param name="value"> <attribution license="cc4" from="Microsoft" modified="false" />The value to validate.</param> <param name="validationContext"> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/ValidationContext.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/ValidationContext.xml index ae5457f42f3..70d54c92b3c 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/ValidationContext.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/ValidationContext.xml @@ -57,10 +57,18 @@ <Parameter Name="items" Type="System.Collections.Generic.IDictionary<System.Object,System.Object>" /> </Parameters> <Docs> - <param name="instance">To be added.</param> - <param name="items">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If <paramref name="items" /> is null, an empty dictionary is created. If <paramref name="items" /> is not null, the set of key/value pairs is copied into a new dictionary, preventing consumers from modifying the original dictionary.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.DataAnnotations.ValidationContext" /> class using the specified object and an optional property bag.</para> + </summary> + <param name="instance"> + <attribution license="cc4" from="Microsoft" modified="false" />The object instance to validate. It cannot be null</param> + <param name="items"> + <attribution license="cc4" from="Microsoft" modified="false" />An optional set of key/value pairs to make available to consumers.</param> </Docs> </Member> <Member MemberName=".ctor"> @@ -76,11 +84,21 @@ <Parameter Name="items" Type="System.Collections.Generic.IDictionary<System.Object,System.Object>" /> </Parameters> <Docs> - <param name="instance">To be added.</param> - <param name="serviceProvider">To be added.</param> - <param name="items">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <paramref name="serviceProvider" /> parameter represents a service that can be used by the <see cref="M:System.ComponentModel.DataAnnotations.ValidationContext.GetService(System.Type)" /> method in order to perform custom validation. </para> + <para>If the <paramref name="items" /> parameter is null, an empty dictionary is created. If the parameter is not null, the set of key/value pairs is copied into a new dictionary, which prevents the service consumers from modifying the original dictionary.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.DataAnnotations.ValidationContext" /> class using the service provider and dictionary of service consumers. </para> + </summary> + <param name="instance"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to validate. This parameter is required.</param> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />The object that implements the <see cref="T:System.IServiceProvider" /> interface. This parameter is optional.</param> + <param name="items"> + <attribution license="cc4" from="Microsoft" modified="false" />A dictionary of key/value pairs to make available to the service consumers. This parameter is optional.</param> </Docs> </Member> <Member MemberName="DisplayName"> @@ -119,7 +137,6 @@ <Parameter Name="serviceType" Type="System.Type" /> </Parameters> <Docs> - <returns>To be added.</returns> <remarks> <attribution license="cc4" from="Microsoft" modified="false" /> <para>If the <see cref="P:System.ComponentModel.DataAnnotations.ValidationContext.ServiceContainer" /> object is defined at the application level, the <see cref="M:System.ComponentModel.DataAnnotations.ValidationContext.GetService(System.Type)" /> method accesses it to retrieve the requested service. </para> @@ -129,6 +146,10 @@ <attribution license="cc4" from="Microsoft" modified="false" /> <para>Returns the service that provides custom validation.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>An instance of the service, or null if the service is not available.</para> + </returns> <param name="serviceType"> <attribution license="cc4" from="Microsoft" modified="false" />The type of the service to use for validation.</param> </Docs> @@ -147,9 +168,13 @@ <Parameter Name="serviceProvider" Type="System.Func<System.Type,System.Object>" /> </Parameters> <Docs> - <param name="serviceProvider">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes the <see cref="T:System.ComponentModel.DataAnnotations.ValidationContext" /> using a service provider that can return service instances by type when <see cref="http://msdn.microsoft.com/en-us/library/system.web.mvc.idependencyresolver.getservice(VS.98).aspx">GetService</see> is called.</para> + </summary> + <param name="serviceProvider"> + <attribution license="cc4" from="Microsoft" modified="false" />The service provider.</param> </Docs> </Member> <Member MemberName="Items"> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/ValidationResult.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/ValidationResult.xml index 70afb8c55c6..2944bc6beaf 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/ValidationResult.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/ValidationResult.xml @@ -73,10 +73,15 @@ <Parameter Name="memberNames" Type="System.Collections.Generic.IEnumerable<System.String>" /> </Parameters> <Docs> - <param name="errorMessage">To be added.</param> - <param name="memberNames">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:System.ComponentModel.DataAnnotations.ValidationResult" /> class by using an error message and a list of members that have validation errors.</para> + </summary> + <param name="errorMessage"> + <attribution license="cc4" from="Microsoft" modified="false" />The error message.</param> + <param name="memberNames"> + <attribution license="cc4" from="Microsoft" modified="false" />The list of member names that have validation errors.</param> </Docs> </Member> <Member MemberName="ErrorMessage"> @@ -153,12 +158,15 @@ </ReturnValue> <Parameters /> <Docs> - <returns>To be added.</returns> <remarks>To be added.</remarks> <summary> <attribution license="cc4" from="Microsoft" modified="false" /> <para>Returns a string representation of the current validation result.</para> </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The current validation result.</para> + </returns> </Docs> </Member> </Members> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/Validator.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/Validator.xml index 4c447d26127..47831754758 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/Validator.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/System.ComponentModel.DataAnnotations/Validator.xml @@ -34,12 +34,24 @@ <Parameter Name="validationResults" Type="System.Collections.Generic.ICollection<System.ComponentModel.DataAnnotations.ValidationResult>" /> </Parameters> <Docs> - <param name="instance">To be added.</param> - <param name="validationContext">To be added.</param> - <param name="validationResults">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method evaluates each <see cref="T:System.ComponentModel.DataAnnotations.ValidationAttribute" /> instance that is attached to the object type. It also checks whether each property that is marked with <see cref="T:System.ComponentModel.DataAnnotations.RequiredAttribute" /> is provided. It does not recursively validate the property values of the object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines whether the specified object is valid using the validation context and validation results collection.</para> + </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the object validates; otherwise, false.</para> + </returns> + <param name="instance"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to validate.</param> + <param name="validationContext"> + <attribution license="cc4" from="Microsoft" modified="false" />The context that describes the object to validate.</param> + <param name="validationResults"> + <attribution license="cc4" from="Microsoft" modified="false" />A collection to hold each failed validation.</param> </Docs> </Member> <Member MemberName="TryValidateObject"> @@ -59,13 +71,26 @@ <Parameter Name="validateAllProperties" Type="System.Boolean" /> </Parameters> <Docs> - <param name="instance">To be added.</param> - <param name="validationContext">To be added.</param> - <param name="validationResults">To be added.</param> - <param name="validateAllProperties">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method evaluates each <see cref="T:System.ComponentModel.DataAnnotations.ValidationAttribute" /> instance that is attached to the object type. It also checks whether each property that is marked with <see cref="T:System.ComponentModel.DataAnnotations.RequiredAttribute" /> is provided. It does not recursively validate the property values of the object.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Determines whether the specified object is valid using the validation context, validation results collection, and a value that specifies whether to validate all properties.</para> + </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the object validates; otherwise, false.</para> + </returns> + <param name="instance"> + <attribution license="cc4" from="Microsoft" modified="false" />The object to validate.</param> + <param name="validationContext"> + <attribution license="cc4" from="Microsoft" modified="false" />The context that describes the object to validate.</param> + <param name="validationResults"> + <attribution license="cc4" from="Microsoft" modified="false" />A collection to hold each failed validation.</param> + <param name="validateAllProperties"> + <attribution license="cc4" from="Microsoft" modified="false" />true to validate all properties; if false, only required attributes are validated..</param> </Docs> </Member> <Member MemberName="TryValidateProperty"> @@ -84,12 +109,24 @@ <Parameter Name="validationResults" Type="System.Collections.Generic.ICollection<System.ComponentModel.DataAnnotations.ValidationResult>" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <param name="validationContext">To be added.</param> - <param name="validationResults">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method tests each <see cref="P:System.ComponentModel.DataAnnotations.ValidationException.ValidationAttribute" /> instance that is associated with the property that is identified by the <paramref name="validationContext" /> parameter.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Validates the property.</para> + </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the property validates; otherwise, false.</para> + </returns> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The value to validate.</param> + <param name="validationContext"> + <attribution license="cc4" from="Microsoft" modified="false" />The context that describes the property to validate.</param> + <param name="validationResults"> + <attribution license="cc4" from="Microsoft" modified="false" />A collection to hold each failed validation. </param> </Docs> </Member> <Member MemberName="TryValidateValue"> @@ -109,13 +146,26 @@ <Parameter Name="validationAttributes" Type="System.Collections.Generic.IEnumerable<System.ComponentModel.DataAnnotations.ValidationAttribute>" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <param name="validationContext">To be added.</param> - <param name="validationResults">To be added.</param> - <param name="validationAttributes">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method tests each validation attribute in the <paramref name="validationAttributes" /> parameter against the <paramref name="value" /> parameter. If the <paramref name="validationResults" /> parameter is not null, this method adds a <see cref="T:System.ComponentModel.DataAnnotations.ValidationResult" /> object for each validation failure to the validation results collection. If the <paramref name="validationResults" /> parameter is null, this method does not add a <see cref="T:System.ComponentModel.DataAnnotations.ValidationResult" /> object to the collection. If a <see cref="T:System.ComponentModel.DataAnnotations.RequiredAttribute" /> attribute is included in the <paramref name="validationAttributes" /> parameter, the <see cref="T:System.ComponentModel.DataAnnotations.RequiredAttribute" /> attribute is evaluated first.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns a value that indicates whether the specified value is valid with the specified attributes.</para> + </summary> + <returns> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>true if the object validates; otherwise, false.</para> + </returns> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The value to validate.</param> + <param name="validationContext"> + <attribution license="cc4" from="Microsoft" modified="false" />The context that describes the object to validate.</param> + <param name="validationResults"> + <attribution license="cc4" from="Microsoft" modified="false" />A collection to hold failed validations. </param> + <param name="validationAttributes"> + <attribution license="cc4" from="Microsoft" modified="false" />The validation attributes.</param> </Docs> </Member> <Member MemberName="ValidateObject"> @@ -224,11 +274,20 @@ <Parameter Name="validationAttributes" Type="System.Collections.Generic.IEnumerable<System.ComponentModel.DataAnnotations.ValidationAttribute>" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <param name="validationContext">To be added.</param> - <param name="validationAttributes">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method tests each validation attribute in the <paramref name="validationAttributes" /> parameter against the <paramref name="value" /> parameter. If a <see cref="T:System.ComponentModel.DataAnnotations.RequiredAttribute" /> attribute is included, the <see cref="T:System.ComponentModel.DataAnnotations.RequiredAttribute" /> attribute is evaluated first.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Validates the specified attributes.</para> + </summary> + <param name="value"> + <attribution license="cc4" from="Microsoft" modified="false" />The value to validate.</param> + <param name="validationContext"> + <attribution license="cc4" from="Microsoft" modified="false" />The context that describes the object to validate.</param> + <param name="validationAttributes"> + <attribution license="cc4" from="Microsoft" modified="false" />The validation attributes.</param> </Docs> </Member> </Members> diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/ns-System.ComponentModel.DataAnnotations.Schema.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/ns-System.ComponentModel.DataAnnotations.Schema.xml index 8b92f8ee5ae..d4210dd1fa3 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/ns-System.ComponentModel.DataAnnotations.Schema.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/ns-System.ComponentModel.DataAnnotations.Schema.xml @@ -1,6 +1,10 @@ +<?xml version="1.0" encoding="utf-8"?> <Namespace Name="System.ComponentModel.DataAnnotations.Schema"> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="N:System.ComponentModel.DataAnnotations.Schema" /> namespace provides support for attribute classes that are used to define metadata for ASP.NET MVC and ASP.NET data controls.</para> + </summary> </Docs> -</Namespace> +</Namespace>
\ No newline at end of file diff --git a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/ns-System.ComponentModel.DataAnnotations.xml b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/ns-System.ComponentModel.DataAnnotations.xml index 04243a78910..9f7d85386b3 100644 --- a/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/ns-System.ComponentModel.DataAnnotations.xml +++ b/mcs/class/System.ComponentModel.DataAnnotations/Documentation/en/ns-System.ComponentModel.DataAnnotations.xml @@ -1,6 +1,10 @@ +<?xml version="1.0" encoding="utf-8"?> <Namespace Name="System.ComponentModel.DataAnnotations"> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="N:System.ComponentModel.DataAnnotations" /> namespace provides attribute classes that are used to define metadata for ASP.NET MVC and ASP.NET data controls. </para> + </summary> </Docs> -</Namespace> +</Namespace>
\ No newline at end of file |