Skip to content

Add remaining missing docs for System.ComponentModel #10370

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
merged 2 commits into from
Sep 10, 2024
Merged

Add remaining missing docs for System.ComponentModel #10370

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
deb71c4
Add remaining missing docs for System.ComponentModel
buyaa-n Sep 6, 2024
f747404
Apply suggestions from code review
buyaa-n Sep 10, 2024
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
6 changes: 3 additions & 3 deletions xml/System.ComponentModel/ComponentResourceManager.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,9 +349,9 @@
</Parameter>
</Parameters>
<Docs>
<param name="value">To be added.</param>
<param name="objectName">To be added.</param>
<param name="culture">To be added.</param>
<param name="value">An <see cref="T:System.Object" /> that contains the property value to be applied.</param>
<param name="objectName">A <see cref="T:System.String" /> that contains the name of the object to look up in the resources.</param>
<param name="culture">The culture for which to apply resources.</param>
<summary>
<para>Examines all the resources for the provided culture.</para>
<para>When it finds a resource with a key in the format of</para>
Expand Down
6 changes: 3 additions & 3 deletions xml/System.ComponentModel/CustomTypeDescriptor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,7 @@
<para>Returns a type converter for the type this type</para>
<para>descriptor is representing.</para>
</summary>
<returns>To be added.</returns>
<returns>A <see cref="T:System.ComponentModel.TypeConverter" /> for the type represented by this type descriptor.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -881,7 +881,7 @@
<para>Returns a collection of event descriptors</para>
<para>for the object this type descriptor is representing.</para>
</summary>
<returns>To be added.</returns>
<returns>An <see cref="T:System.ComponentModel.EventDescriptorCollection" /> containing the event descriptors for the object represented by this type descriptor.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1078,7 +1078,7 @@
<para>Returns a collection of property descriptors</para>
<para>for the object this type descriptor is representing.</para>
</summary>
<returns>To be added.</returns>
<returns>A <see cref="T:System.ComponentModel.PropertyDescriptorCollection" /> containing the property descriptions for the object represented by this type descriptor.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
22 changes: 11 additions & 11 deletions xml/System.ComponentModel/TypeDescriptionProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,9 +437,9 @@
<Parameter Name="instance" Type="System.Object" Index="0" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="instance">To be added.</param>
<param name="instance">The object for which to get the extended type descriptor.</param>
<summary>Returns an extended custom type descriptor for the given object.</summary>
<returns>To be added.</returns>
<returns>An <see cref="T:System.ComponentModel.ICustomTypeDescriptor" /> that can provide extended metadata for the object.</returns>
<remarks>An extended type descriptor is a custom type descriptor that offers properties that other objects have added to this object, but are not actually defined on the object. For example, in the .NET Framework Component Model, objects that implement the interface IExtenderProvider can "attach" properties to other objects that reside in the same logical container. The GetTypeDescriptor method does not return a type descriptor that provides these extra extended properties. GetExtendedTypeDescriptor returns the set of these extended properties. TypeDescriptor will automatically merge the results of these two property collections. Note that while the .NET Framework component model only supports extended properties this API can be used for extended attributes and events as well, if the type description provider supports it.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1035,9 +1035,9 @@
<Parameter Name="instance" Type="System.Object" Index="0" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="instance">To be added.</param>
<param name="instance">An instance of the type. Can be <see langword="null" /> if no instance was passed to the <see cref="T:System.ComponentModel.TypeDescriptor" />.</param>
<summary>Returns a custom type descriptor for the given type or object.</summary>
<returns>To be added.</returns>
<returns>An <see cref="T:System.ComponentModel.ICustomTypeDescriptor" /> that can provide metadata for the type.</returns>
<remarks>The objectType parameter is always valid, but the instance parameter may be <see langword="null" /> if no instance was passed to TypeDescriptor. The method should return a custom type descriptor for the object. If the method is not interested in providing type information for the object it should return base.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1072,9 +1072,9 @@
<Parameter Name="objectType" Type="System.Type" Index="0" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="objectType">To be added.</param>
<param name="objectType">The type of object for which to retrieve the type descriptor.</param>
<summary>Returns a custom type descriptor for the given type or object.</summary>
<returns>To be added.</returns>
<returns>An <see cref="T:System.ComponentModel.ICustomTypeDescriptor" /> that can provide metadata for the type.</returns>
<remarks>The objectType parameter is always valid, but the instance parameter may be <see langword="null" /> if no instance was passed to TypeDescriptor. The method should return a custom type descriptor for the object. If the method is not interested in providing type information for the object it should return base.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1117,10 +1117,10 @@
<Parameter Name="instance" Type="System.Object" Index="1" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="objectType">To be added.</param>
<param name="instance">To be added.</param>
<param name="objectType">The type of object for which to retrieve the type descriptor.</param>
<param name="instance">An instance of the type. Can be <see langword="null" /> if no instance was passed to the <see cref="T:System.ComponentModel.TypeDescriptor" />.</param>
<summary>Returns a custom type descriptor for the given type or object.</summary>
<returns>To be added.</returns>
<returns>An <see cref="T:System.ComponentModel.ICustomTypeDescriptor" /> that can provide metadata for the type.</returns>
<remarks>
<para>The objectType parameter is always valid, but the instance parameter may be <see langword="null" /> if no instance was passed to TypeDescriptor. The method should return a custom type descriptor for the object. If the method is not interested in providing type information for the object it should return base.</para>
<para>This method is prototyped as virtual, and by default returns a custom type descriptor that returns empty collections for all values if no parent provider was passed. If a parent provider was passed, this method will invoke the parent provider's GetTypeDescriptorFromRegisteredType method.</para>
Expand Down Expand Up @@ -1152,9 +1152,9 @@
<Parameter Name="type" Type="System.Type" Index="0" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="type">To be added.</param>
<param name="type">The type to check if it was registered.</param>
<summary>Determines whether the type was registered with its provider through <see cref="M:System.ComponentModel.TypeDescriptor.RegisterType``1" />.</summary>
<returns>To be added.</returns>
<returns><see langword="true" /> if <paramref name="type" /> is registered; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="type" /> is <see langword="null" />.</exception>
Expand Down
20 changes: 10 additions & 10 deletions xml/System.ComponentModel/TypeDescriptor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2221,9 +2221,9 @@
<Parameter Name="component" Type="System.Object" Index="0" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="component">To be added.</param>
<param name="component">A component to get the converter for.</param>
<summary>Gets a type converter for the type of the specified component.</summary>
<returns>To be added.</returns>
<returns>A <see cref="T:System.ComponentModel.TypeConverter" /> for the specified component.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -2252,9 +2252,9 @@
<Parameter Name="type" Type="System.Type" Index="0" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="type">To be added.</param>
<param name="type">The <see cref="T:System.Type" /> of the target component.</param>
<summary>Gets a type converter for the specified registered type.</summary>
<returns>To be added.</returns>
<returns>A <see cref="T:System.ComponentModel.TypeConverter" /> for the specified type.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -3510,9 +3510,9 @@
<Parameter Name="componentType" Type="System.Type" Index="0" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="componentType">To be added.</param>
<param name="componentType">The <see cref="T:System.Type" /> of the target component.</param>
<summary>Gets a collection of events for a specified type of component.</summary>
<returns>To be added.</returns>
<returns>An <see cref="T:System.ComponentModel.EventDescriptorCollection" /> with the events for this component.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -4163,9 +4163,9 @@
<Parameter Name="component" Type="System.Object" Index="0" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="component">To be added.</param>
<param name="component">A component to get the properties for.</param>
<summary>Gets a collection of properties for a specified component.</summary>
<returns>To be added.</returns>
<returns>A <see cref="T:System.ComponentModel.PropertyDescriptorCollection" /> with the properties for the specified component.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -4194,9 +4194,9 @@
<Parameter Name="componentType" Type="System.Type" Index="0" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="componentType">To be added.</param>
<param name="componentType">A <see cref="T:System.Type" /> that represents the component to get properties for.</param>
<summary>Gets a collection of properties for a specified type.</summary>
<returns>To be added.</returns>
<returns>A <see cref="T:System.ComponentModel.PropertyDescriptorCollection" /> with the properties for a specified type of component.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down