Skip to content

Fix <seealso> links #4337

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 4 commits into from
Jun 5, 2020
Merged

Fix <seealso> links #4337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
17c8f21
fix see cref links
gewarren Jun 4, 2020
35295bb
review on staging
gewarren Jun 5, 2020
31ac5b0
more review on staging
gewarren Jun 5, 2020
f6f3bd0
pull upstream master
gewarren Jun 5, 2020
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.DependencyInjection/OptionsBuilderDataAnnotationsExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
</Base>
<Interfaces />
<Docs>
<summary>Extension methods for adding configuration related options services to the DI container via <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</summary>
<summary>Extension methods for adding configuration-related options services to the DI container via <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -50,7 +50,7 @@
<Docs>
<typeparam name="TOptions">The options type to be configured.</typeparam>
<param name="optionsBuilder">The options builder to add the services to.</param>
<summary>Register this options instance for validation of its DataAnnotations.</summary>
<summary>Registers this options instance for validation of its DataAnnotations.</summary>
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> so that additional calls can be chained.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down
27 changes: 11 additions & 16 deletions xml/Microsoft.Extensions.DependencyInjection/OptionsServiceCollectionExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<Docs>
<typeparam name="TOptions">The options type to be configured.</typeparam>
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
<summary>Gets an options builder that forwards Configure calls for the same <typeparamref name="TOptions" /> to the underlying service collection.</summary>
<summary>Gets an options builder that forwards <c>Configure</c> calls for the same named <typeparamref name="TOptions" /> to the underlying service collection.</summary>
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> so that configure calls can be chained in it.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -124,8 +124,8 @@
<typeparam name="TOptions">The options type to be configured.</typeparam>
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
<param name="name">The name of the options instance.</param>
<summary>Gets an options builder that forwards Configure calls for the same named <typeparamref name="TOptions" /> to the underlying service collection.</summary>
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> so that configure calls can be chained in it.</returns>
<summary>Gets an options builder that forwards <c>Configure</c> calls for the same named <typeparamref name="TOptions" /> to the underlying service collection.</summary>
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> so that <c>Configure</c> calls can be chained in it.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -165,8 +165,7 @@
<typeparam name="TOptions">The options type to be configured.</typeparam>
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
<param name="configureOptions">The action used to configure the options.</param>
<summary>Registers an action used to configure a particular type of options.
Note: These are run before all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
<summary>Registers an action used to configure a particular type of options. These are run before <see cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -207,8 +206,7 @@
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
<param name="name">The name of the options instance.</param>
<param name="configureOptions">The action used to configure the options.</param>
<summary>Registers an action used to configure a particular type of options.
Note: These are run before all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
<summary>Registers an action used to configure a particular type of options. These are run before <see cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -277,7 +275,7 @@
<Docs>
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
<param name="configureInstance">The instance that will configure options.</param>
<summary>Registers an object that will have all of its I[Post]ConfigureOptions registered.</summary>
<summary>Registers an object that will have all of its <c>I[Post]ConfigureOptions</c> registered.</summary>
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -307,7 +305,7 @@
<Docs>
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
<param name="configureType">The type that will configure options.</param>
<summary>Registers a type that will have all of its I[Post]ConfigureOptions registered.</summary>
<summary>Registers a type that will have all of its <c>I[Post]ConfigureOptions</c> registered.</summary>
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -343,7 +341,7 @@
<Docs>
<typeparam name="TConfigureOptions">The type that will configure options.</typeparam>
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
<summary>Registers a type that will have all of its I[Post]ConfigureOptions registered.</summary>
<summary>Registers a type that will have all of its <c>I[Post]ConfigureOptions</c> registered.</summary>
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -382,8 +380,7 @@
<typeparam name="TOptions">The options type to be configured.</typeparam>
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
<param name="configureOptions">The action used to configure the options.</param>
<summary>Registers an action used to initialize a particular type of options.
Note: These are run after all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
<summary>Registers an action used to initialize a particular type of options. These are run after <see cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -424,8 +421,7 @@
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
<param name="name">The name of the options instance.</param>
<param name="configureOptions">The action used to configure the options.</param>
<summary>Registers an action used to configure a particular type of options.
Note: These are run after all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
<summary>Registers an action used to configure a particular type of options. These are run after <see cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -464,8 +460,7 @@
<typeparam name="TOptions">The options type to be configured.</typeparam>
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
<param name="configureOptions">The action used to configure the options.</param>
<summary>Registers an action used to post configure all instances of a particular type of options.
Note: These are run after all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
<summary>Registers an action used to post configure all instances of a particular type of options. These are run after <see cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down
39 changes: 15 additions & 24 deletions xml/Microsoft.Extensions.FileProviders.Physical/PhysicalFilesWatcher.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,10 @@
<Parameter Name="pollForChanges" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="root">Root directory for the watcher</param>
<param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" /></param>
<param name="pollForChanges">
True when the watcher should use polling to trigger instances of
<see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> created by <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)" /></param>
<summary>Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher" /> that watches files in <paramref name="root" />.
Wraps an instance of <see cref="T:System.IO.FileSystemWatcher" /></summary>
<param name="root">Root directory for the watcher.</param>
<param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" />.</param>
<param name="pollForChanges"><see langword="true" /> when the watcher should use polling to trigger instances of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> created by <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)" />.</param>
<summary>Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher" /> that watches files in <paramref name="root" />. Wraps an instance of <see cref="T:System.IO.FileSystemWatcher" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -87,14 +84,12 @@
<Parameter Name="filters" Type="Microsoft.Extensions.FileProviders.Physical.ExclusionFilters" Index="3" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1" />
</Parameters>
<Docs>
<param name="root">Root directory for the watcher</param>
<param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" /></param>
<param name="pollForChanges">
True when the watcher should use polling to trigger instances of
<see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> created by <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)" /></param>
<param name="root">Root directory for the watcher.</param>
<param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" />.</param>
<param name="pollForChanges"><see langword="true" /> when the watcher should use polling to trigger instances of
<see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> created by <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)" />.</param>
<param name="filters">Specifies which files or directories are excluded. Notifications of changes to are not raised to these.</param>
<summary>Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher" /> that watches files in <paramref name="root" />.
Wraps an instance of <see cref="T:System.IO.FileSystemWatcher" /></summary>
<summary>Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher" /> that watches files in <paramref name="root" />. Wraps an instance of <see cref="T:System.IO.FileSystemWatcher" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -123,17 +118,14 @@
<Parameter Name="filter" Type="System.String" />
</Parameters>
<Docs>
<param name="filter">A globbing pattern for files and directories to watch</param>
<param name="filter">A globbing pattern for files and directories to watch.</param>
<summary>
<para>Creates an instance of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for all files and directories that match the
<paramref name="filter" /></para>
<para>Globbing patterns are relative to the root directory given in the constructor
<seealso cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.#ctor(System.String,System.IO.FileSystemWatcher,System.Boolean)" />. Globbing patterns
are interpreted by <seealso cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />.</para>
<para>Creates an instance of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for all files and directories that match the <paramref name="filter" />.</para>
<para>Globbing patterns are relative to the root directory given in the constructor <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.#ctor(System.String,System.IO.FileSystemWatcher,System.Boolean)" />. Globbing patterns are interpreted by <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />.</para>
</summary>
<returns>A change token for all files that match the filter</returns>
<returns>A change token for all files that match the filter.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">When <paramref name="filter" /> is null</exception>
<exception cref="T:System.ArgumentNullException">When <paramref name="filter" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="Dispose">
Expand Down Expand Up @@ -187,8 +179,7 @@
<Parameter Name="disposing" Type="System.Boolean" Index="0" FrameworkAlternate="dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1" />
</Parameters>
<Docs>
<param name="disposing">
<see langword="true" /> is invoked from <see cref="M:System.IDisposable.Dispose" />.</param>
<param name="disposing">If <see langword="true" />, is invoked from <see cref="M:System.IDisposable.Dispose" />.</param>
<summary>Disposes the provider.</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down
Loading