Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Port docs from WinForms #8393

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

Closed
wants to merge 1 commit into from
Closed

Port docs from WinForms #8393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Configuration/ConfigurationManager.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@
<Parameter Name="key" Type="System.String" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="key">The key of the configuration section.</param>
<summary>Gets a configuration subsection with the specified key.</summary>
<returns>The configuration section for the specified key.</returns>
<remarks>The name of the configuration section is case-insensitive.</remarks>
Expand Down Expand Up @@ -160,7 +160,7 @@
<Docs>
<param name="key">The item index.</param>
<summary>Gets or sets a configuration value.</summary>
<value>To be added.</value>
<value>The configuration value.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down
25 changes: 13 additions & 12 deletions xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@
<Parameter Name="item" Type="Microsoft.Extensions.DependencyInjection.ServiceDescriptor" />
</Parameters>
<Docs>
<param name="item">To be added.</param>
<param name="item">The object to locate in the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
<summary>Determines whether the <see cref="T:System.Collections.Generic.ICollection`1" /> contains a specific value.</summary>
<returns>
<see langword="true" /> if <paramref name="item" /> is found in the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -205,8 +205,8 @@
<Parameter Name="arrayIndex" Type="System.Int32" />
</Parameters>
<Docs>
<param name="array">To be added.</param>
<param name="arrayIndex">To be added.</param>
<param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from <see cref="T:System.Collections.Generic.ICollection`1" />. The <see cref="T:System.Array" /> must have zero-based indexing.</param>
<param name="arrayIndex">The zero-based index in <paramref name="array" /> at which copying begins.</param>
<summary>Copies the elements of the <see cref="T:System.Collections.Generic.ICollection`1" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
Expand Down Expand Up @@ -245,7 +245,7 @@
</ReturnValue>
<Docs>
<summary>Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
<value>To be added.</value>
<value>The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -324,7 +324,7 @@
<Parameter Name="item" Type="Microsoft.Extensions.DependencyInjection.ServiceDescriptor" />
</Parameters>
<Docs>
<param name="item">To be added.</param>
<param name="item">The object to locate in the <see cref="T:System.Collections.Generic.IList`1" />.</param>
<summary>Determines the index of a specific item in the <see cref="T:System.Collections.Generic.IList`1" />.</summary>
<returns>The index of <paramref name="item" /> if found in the list; otherwise, -1.</returns>
<remarks>To be added.</remarks>
Expand Down Expand Up @@ -367,8 +367,8 @@
<Parameter Name="item" Type="Microsoft.Extensions.DependencyInjection.ServiceDescriptor" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<param name="item">To be added.</param>
<param name="index">The zero-based index at which <paramref name="item" /> should be inserted.</param>
<param name="item">The object to insert into the <see cref="T:System.Collections.Generic.IList`1" />.</param>
<summary>Inserts an item to the <see cref="T:System.Collections.Generic.IList`1" /> at the specified index.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
Expand Down Expand Up @@ -407,7 +407,8 @@
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only.</summary>
<value>To be added.</value>
<value>
<see langword="true" /> if the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -447,9 +448,9 @@
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<param name="index">The zero-based index of the element to get or set.</param>
<summary>Gets or sets the element at the specified index.</summary>
<value>To be added.</value>
<value>The element at the specified index.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -521,7 +522,7 @@ After the collection is marked as read-only, any further attempt to modify it th
<Parameter Name="item" Type="Microsoft.Extensions.DependencyInjection.ServiceDescriptor" />
</Parameters>
<Docs>
<param name="item">To be added.</param>
<param name="item">The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
<summary>Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
<returns>
<see langword="true" /> if <paramref name="item" /> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, <see langword="false" />. This method also returns <see langword="false" /> if <paramref name="item" /> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1" />.</returns>
Expand Down Expand Up @@ -564,7 +565,7 @@ After the collection is marked as read-only, any further attempt to modify it th
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<param name="index">The zero-based index of the item to remove.</param>
<summary>Removes the <see cref="T:System.Collections.Generic.IList`1" /> item at the specified index.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Logging.Abstractions/NullLogger.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<Parameter Name="state" Type="TState" />
</Parameters>
<Docs>
<typeparam name="TState">To be added.</typeparam>
<typeparam name="TState">The type of the state to begin scope for.</typeparam>
<param name="state">The identifier for the scope.</param>
<summary>Begins a logical operation scope.</summary>
<returns>A disposable object that ends the logical operation scope on dispose.</returns>
Expand Down Expand Up @@ -176,7 +176,7 @@
<Parameter Name="formatter" Type="System.Func&lt;TState,System.Exception,System.String&gt;" />
</Parameters>
<Docs>
<typeparam name="TState">To be added.</typeparam>
<typeparam name="TState">The type of the object to be written.</typeparam>
<param name="logLevel">Entry will be written on this level.</param>
<param name="eventId">Id of the event.</param>
<param name="state">The entry to be written. Can be also an object.</param>
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Logging.Abstractions/NullLogger`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
<Parameter Name="state" Type="TState" />
</Parameters>
<Docs>
<typeparam name="TState">To be added.</typeparam>
<typeparam name="TState">The type of the state to begin scope for.</typeparam>
<param name="state">The identifier for the scope.</param>
<summary>Begins a logical operation scope.</summary>
<returns>A disposable object that ends the logical operation scope on dispose.</returns>
Expand Down Expand Up @@ -202,7 +202,7 @@
<Parameter Name="formatter" Type="System.Func&lt;TState,System.Exception,System.String&gt;" />
</Parameters>
<Docs>
<typeparam name="TState">To be added.</typeparam>
<typeparam name="TState">The type of the object to be written.</typeparam>
<param name="logLevel">Entry will be written on this level.</param>
<param name="eventId">Id of the event.</param>
<param name="state">The entry to be written. Can be also an object.</param>
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Logging.Debug/DebugLogger.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
<Parameter Name="state" Type="TState" />
</Parameters>
<Docs>
<typeparam name="TState">To be added.</typeparam>
<typeparam name="TState">The type of the state to begin scope for.</typeparam>
<param name="state">The identifier for the scope.</param>
<summary>Begins a logical operation scope.</summary>
<returns>A disposable object that ends the logical operation scope on dispose.</returns>
Expand Down Expand Up @@ -182,7 +182,7 @@
<Parameter Name="formatter" Type="System.Func&lt;TState,System.Exception,System.String&gt;" />
</Parameters>
<Docs>
<typeparam name="TState">To be added.</typeparam>
<typeparam name="TState">The type of the object to be written.</typeparam>
<param name="logLevel">Entry will be written on this level.</param>
<param name="eventId">Id of the event.</param>
<param name="state">The entry to be written. Can be also an object.</param>
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Logging.EventLog/EventLogLogger.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@
<Parameter Name="state" Type="TState" />
</Parameters>
<Docs>
<typeparam name="TState">To be added.</typeparam>
<typeparam name="TState">The type of the state to begin scope for.</typeparam>
<param name="state">The identifier for the scope.</param>
<summary>Begins a logical operation scope.</summary>
<returns>A disposable object that ends the logical operation scope on dispose.</returns>
Expand Down Expand Up @@ -239,7 +239,7 @@
<Parameter Name="formatter" Type="System.Func&lt;TState,System.Exception,System.String&gt;" />
</Parameters>
<Docs>
<typeparam name="TState">To be added.</typeparam>
<typeparam name="TState">The type of the object to be written.</typeparam>
<param name="logLevel">Entry will be written on this level.</param>
<param name="eventId">Id of the event.</param>
<param name="state">The entry to be written. Can be also an object.</param>
Expand Down
2 changes: 1 addition & 1 deletion xml/Microsoft.Extensions.Logging/LoggerExternalScopeProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
<Parameter Name="state" Type="TState" />
</Parameters>
<Docs>
<typeparam name="TState">To be added.</typeparam>
<typeparam name="TState">The type of state to accept.</typeparam>
<param name="callback">The callback to be executed for every scope object.</param>
<param name="state">The state object to be passed into the callback.</param>
<summary>Executes callback for each currently active scope objects in order of creation.
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Logging/Logger`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
<Parameter Name="state" Type="TState" />
</Parameters>
<Docs>
<typeparam name="TState">To be added.</typeparam>
<typeparam name="TState">The type of the state to begin scope for.</typeparam>
<param name="state">The identifier for the scope.</param>
<summary>Begins a logical operation scope.</summary>
<returns>A disposable object that ends the logical operation scope on dispose.</returns>
Expand Down Expand Up @@ -189,7 +189,7 @@
<Parameter Name="formatter" Type="System.Func&lt;TState,System.Exception,System.String&gt;" />
</Parameters>
<Docs>
<typeparam name="TState">To be added.</typeparam>
<typeparam name="TState">The type of the object to be written.</typeparam>
<param name="logLevel">Entry will be written on this level.</param>
<param name="eventId">Id of the event.</param>
<param name="state">The entry to be written. Can be also an object.</param>
Expand Down
2 changes: 1 addition & 1 deletion xml/Microsoft.VisualBasic.ApplicationServices/ConsoleApplicationBase.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.VisualBasic.ApplicationServices.ConsoleApplicationBase" /> class.</summary>
<remarks>To be added.</remarks>
<remarks>We have to have a parameterless constructor because the platform specific Application object derives from this one and it doesn't define a constructor. The partial class generated by the designer defines the constructor in order to configure the application.</remarks>
<related type="Article" href="/dotnet/visual-basic/language-reference/objects/">Objects (Visual Basic)</related>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.VisualBasic.ApplicationServices.WindowsFormsApplicationBase" /> class.</summary>
<remarks>To be added.</remarks>
<remarks>We have to have a parameterless ctor because the platform specific Application object derives from this one and it doesn't define a ctor because the partial class generated by the designer does that to configure the application.</remarks>
<related type="Article" href="/dotnet/visual-basic/language-reference/objects/">Objects (Visual Basic)</related>
</Docs>
</Member>
Expand Down
1 change: 1 addition & 0 deletions xml/System.ComponentModel.Design/BinaryEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@
<summary>Gets the editor style used by the <see cref="M:System.ComponentModel.Design.BinaryEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</summary>
<returns>An <see langword="enum" /> value indicating the provided editing style.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/System.ComponentModel.Design/CollectionEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -664,6 +664,7 @@
<summary>Gets the edit style used by the <see cref="M:System.ComponentModel.Design.CollectionEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</summary>
<returns>A <see cref="T:System.Drawing.Design.UITypeEditorEditStyle" /> enumeration value indicating the provided editing style. If the method is not supported in the specified context, this method will return the <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" /> identifier.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetItems">
Expand Down
1 change: 1 addition & 0 deletions xml/System.ComponentModel.Design/DateTimeEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@
<summary>Retrieves the editing style of the <see cref="Overload:System.ComponentModel.Design.DateTimeEditor.EditValue" /> method. If the method is not supported, this will return None.</summary>
<returns>An <see langword="enum" /> value indicating the provided editing style.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/System.ComponentModel.Design/MultilineStringEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@
<summary>Edits the specified object value using the edit style provided by <see cref="M:System.Drawing.Design.ImageEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)" />.</summary>
<returns>The new value of the object. If the value of the object has not changed, this method should return the same object passed to it.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetEditStyle">
Expand Down
2 changes: 2 additions & 0 deletions xml/System.ComponentModel.Design/ObjectSelectorEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="EqualsToValue">
Expand Down Expand Up @@ -421,6 +422,7 @@
<param name="value">The specified value.</param>
<summary>Sets the current <see cref="T:System.ComponentModel.Design.ObjectSelectorEditor" /> to the specified value.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="SubObjectSelector">
Expand Down
3 changes: 3 additions & 0 deletions xml/System.Drawing.Design/ColorEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@
<summary>Gets the editing style of the Edit method. If the method is not supported, this will return <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" />.</summary>
<returns>An enum value indicating the provided editing style.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetPaintValueSupported">
Expand Down Expand Up @@ -201,6 +202,7 @@
<returns>
<see langword="true" /> if <see cref="Overload:System.Drawing.Design.ColorEditor.PaintValue" /> is implemented; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="PaintValue">
Expand Down Expand Up @@ -244,6 +246,7 @@

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/System.Drawing.Design/ContentAlignmentEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@
<summary>Gets the editing style of the <see cref="Overload:System.Drawing.Design.ContentAlignmentEditor.EditValue" /> method.</summary>
<returns>A <see cref="T:System.Drawing.Design.UITypeEditorEditStyle" /> value indicating the provided editing style. If the method to retrieve the edit style is not supported, this will return <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
1 change: 1 addition & 0 deletions xml/System.Drawing.Design/CursorEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@
<summary>Retrieves the editing style of the <see cref="Overload:System.Drawing.Design.CursorEditor.EditValue" /> method.</summary>
<returns>An enum value indicating the provided editing style. If the method is not supported, this will return <see cref="F:System.Drawing.Design.UITypeEditorEditStyle.None" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="IsDropDownResizable">
Expand Down
1 change: 1 addition & 0 deletions xml/System.Drawing.Design/FontEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@
<summary>Gets the editor style used by the <see cref="M:System.Drawing.Design.FontEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" /> method.</summary>
<returns>A <see cref="T:System.Drawing.Design.UITypeEditorEditStyle" /> value that indicates the style of editor used by <see cref="M:System.Drawing.Design.FontEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Drawing.Design/FontNameEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@
<returns>
<see langword="true" /> if <see cref="Overload:System.Drawing.Design.FontNameEditor.PaintValue" /> is implemented; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="PaintValue">
Expand Down Expand Up @@ -152,6 +153,7 @@
<param name="e">What to paint and where to paint it.</param>
<summary>Paints a representative value of the given object to the provided canvas. Painting should be done within the boundaries of the provided rectangle.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Drawing.Design/IconEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,7 @@
<returns>
<see langword="true" /> if <see cref="Overload:System.Drawing.Design.UITypeEditor.PaintValue" /> is implemented; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="LoadFromStream">
Expand Down Expand Up @@ -443,6 +444,7 @@

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
3 changes: 3 additions & 0 deletions xml/System.Drawing.Design/ImageEditor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,7 @@

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetExtensions">
Expand Down Expand Up @@ -419,6 +420,7 @@
<returns>
<see langword="true" /> if <see cref="M:System.Drawing.Design.ImageEditor.PaintValue(System.Drawing.Design.PaintValueEventArgs)" /> is implemented; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="LoadFromStream">
Expand Down Expand Up @@ -499,6 +501,7 @@

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
Loading