Skip to content

Commit 485eb38

Browse files
authored
Fix <seealso> links (#4337)
* fix see cref links
1 parent 6284e66 commit 485eb38

File tree

7 files changed

+66
-97
lines changed

7 files changed

+66
-97
lines changed

xml/Microsoft.Extensions.DependencyInjection/OptionsBuilderDataAnnotationsExtensions.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
</Base>
1717
<Interfaces />
1818
<Docs>
19-
<summary>Extension methods for adding configuration related options services to the DI container via <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</summary>
19+
<summary>Extension methods for adding configuration-related options services to the DI container via <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" />.</summary>
2020
<remarks>To be added.</remarks>
2121
</Docs>
2222
<Members>
@@ -50,7 +50,7 @@
5050
<Docs>
5151
<typeparam name="TOptions">The options type to be configured.</typeparam>
5252
<param name="optionsBuilder">The options builder to add the services to.</param>
53-
<summary>Register this options instance for validation of its DataAnnotations.</summary>
53+
<summary>Registers this options instance for validation of its DataAnnotations.</summary>
5454
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> so that additional calls can be chained.</returns>
5555
<remarks>To be added.</remarks>
5656
</Docs>

xml/Microsoft.Extensions.DependencyInjection/OptionsServiceCollectionExtensions.xml

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@
8686
<Docs>
8787
<typeparam name="TOptions">The options type to be configured.</typeparam>
8888
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
89-
<summary>Gets an options builder that forwards Configure calls for the same <typeparamref name="TOptions" /> to the underlying service collection.</summary>
89+
<summary>Gets an options builder that forwards <c>Configure</c> calls for the same named <typeparamref name="TOptions" /> to the underlying service collection.</summary>
9090
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> so that configure calls can be chained in it.</returns>
9191
<remarks>To be added.</remarks>
9292
</Docs>
@@ -124,8 +124,8 @@
124124
<typeparam name="TOptions">The options type to be configured.</typeparam>
125125
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
126126
<param name="name">The name of the options instance.</param>
127-
<summary>Gets an options builder that forwards Configure calls for the same named <typeparamref name="TOptions" /> to the underlying service collection.</summary>
128-
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> so that configure calls can be chained in it.</returns>
127+
<summary>Gets an options builder that forwards <c>Configure</c> calls for the same named <typeparamref name="TOptions" /> to the underlying service collection.</summary>
128+
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> so that <c>Configure</c> calls can be chained in it.</returns>
129129
<remarks>To be added.</remarks>
130130
</Docs>
131131
</Member>
@@ -165,8 +165,7 @@
165165
<typeparam name="TOptions">The options type to be configured.</typeparam>
166166
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
167167
<param name="configureOptions">The action used to configure the options.</param>
168-
<summary>Registers an action used to configure a particular type of options.
169-
Note: These are run before all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
168+
<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>
170169
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
171170
<remarks>To be added.</remarks>
172171
</Docs>
@@ -207,8 +206,7 @@
207206
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
208207
<param name="name">The name of the options instance.</param>
209208
<param name="configureOptions">The action used to configure the options.</param>
210-
<summary>Registers an action used to configure a particular type of options.
211-
Note: These are run before all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.PostConfigure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
209+
<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>
212210
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
213211
<remarks>To be added.</remarks>
214212
</Docs>
@@ -277,7 +275,7 @@
277275
<Docs>
278276
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
279277
<param name="configureInstance">The instance that will configure options.</param>
280-
<summary>Registers an object that will have all of its I[Post]ConfigureOptions registered.</summary>
278+
<summary>Registers an object that will have all of its <c>I[Post]ConfigureOptions</c> registered.</summary>
281279
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
282280
<remarks>To be added.</remarks>
283281
</Docs>
@@ -307,7 +305,7 @@
307305
<Docs>
308306
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
309307
<param name="configureType">The type that will configure options.</param>
310-
<summary>Registers a type that will have all of its I[Post]ConfigureOptions registered.</summary>
308+
<summary>Registers a type that will have all of its <c>I[Post]ConfigureOptions</c> registered.</summary>
311309
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
312310
<remarks>To be added.</remarks>
313311
</Docs>
@@ -343,7 +341,7 @@
343341
<Docs>
344342
<typeparam name="TConfigureOptions">The type that will configure options.</typeparam>
345343
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
346-
<summary>Registers a type that will have all of its I[Post]ConfigureOptions registered.</summary>
344+
<summary>Registers a type that will have all of its <c>I[Post]ConfigureOptions</c> registered.</summary>
347345
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
348346
<remarks>To be added.</remarks>
349347
</Docs>
@@ -382,8 +380,7 @@
382380
<typeparam name="TOptions">The options type to be configured.</typeparam>
383381
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
384382
<param name="configureOptions">The action used to configure the options.</param>
385-
<summary>Registers an action used to initialize a particular type of options.
386-
Note: These are run after all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
383+
<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>
387384
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
388385
<remarks>To be added.</remarks>
389386
</Docs>
@@ -424,8 +421,7 @@
424421
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
425422
<param name="name">The name of the options instance.</param>
426423
<param name="configureOptions">The action used to configure the options.</param>
427-
<summary>Registers an action used to configure a particular type of options.
428-
Note: These are run after all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
424+
<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>
429425
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
430426
<remarks>To be added.</remarks>
431427
</Docs>
@@ -464,8 +460,7 @@
464460
<typeparam name="TOptions">The options type to be configured.</typeparam>
465461
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add the services to.</param>
466462
<param name="configureOptions">The action used to configure the options.</param>
467-
<summary>Registers an action used to post configure all instances of a particular type of options.
468-
Note: These are run after all <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{``0})" />.</summary>
463+
<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>
469464
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> so that additional calls can be chained.</returns>
470465
<remarks>To be added.</remarks>
471466
</Docs>

xml/Microsoft.Extensions.FileProviders.Physical/PhysicalFilesWatcher.xml

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,10 @@
5555
<Parameter Name="pollForChanges" Type="System.Boolean" />
5656
</Parameters>
5757
<Docs>
58-
<param name="root">Root directory for the watcher</param>
59-
<param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" /></param>
60-
<param name="pollForChanges">
61-
True when the watcher should use polling to trigger instances of
62-
<see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> created by <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)" /></param>
63-
<summary>Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher" /> that watches files in <paramref name="root" />.
64-
Wraps an instance of <see cref="T:System.IO.FileSystemWatcher" /></summary>
58+
<param name="root">Root directory for the watcher.</param>
59+
<param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" />.</param>
60+
<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>
61+
<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>
6562
<remarks>To be added.</remarks>
6663
</Docs>
6764
</Member>
@@ -87,14 +84,12 @@
8784
<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" />
8885
</Parameters>
8986
<Docs>
90-
<param name="root">Root directory for the watcher</param>
91-
<param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" /></param>
92-
<param name="pollForChanges">
93-
True when the watcher should use polling to trigger instances of
94-
<see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> created by <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)" /></param>
87+
<param name="root">Root directory for the watcher.</param>
88+
<param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" />.</param>
89+
<param name="pollForChanges"><see langword="true" /> when the watcher should use polling to trigger instances of
90+
<see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> created by <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)" />.</param>
9591
<param name="filters">Specifies which files or directories are excluded. Notifications of changes to are not raised to these.</param>
96-
<summary>Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher" /> that watches files in <paramref name="root" />.
97-
Wraps an instance of <see cref="T:System.IO.FileSystemWatcher" /></summary>
92+
<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>
9893
<remarks>To be added.</remarks>
9994
</Docs>
10095
</Member>
@@ -123,17 +118,14 @@
123118
<Parameter Name="filter" Type="System.String" />
124119
</Parameters>
125120
<Docs>
126-
<param name="filter">A globbing pattern for files and directories to watch</param>
121+
<param name="filter">A globbing pattern for files and directories to watch.</param>
127122
<summary>
128-
<para>Creates an instance of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for all files and directories that match the
129-
<paramref name="filter" /></para>
130-
<para>Globbing patterns are relative to the root directory given in the constructor
131-
<seealso cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.#ctor(System.String,System.IO.FileSystemWatcher,System.Boolean)" />. Globbing patterns
132-
are interpreted by <seealso cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />.</para>
123+
<para>Creates an instance of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for all files and directories that match the <paramref name="filter" />.</para>
124+
<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>
133125
</summary>
134-
<returns>A change token for all files that match the filter</returns>
126+
<returns>A change token for all files that match the filter.</returns>
135127
<remarks>To be added.</remarks>
136-
<exception cref="T:System.ArgumentNullException">When <paramref name="filter" /> is null</exception>
128+
<exception cref="T:System.ArgumentNullException">When <paramref name="filter" /> is null.</exception>
137129
</Docs>
138130
</Member>
139131
<Member MemberName="Dispose">
@@ -187,8 +179,7 @@
187179
<Parameter Name="disposing" Type="System.Boolean" Index="0" FrameworkAlternate="dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1" />
188180
</Parameters>
189181
<Docs>
190-
<param name="disposing">
191-
<see langword="true" /> is invoked from <see cref="M:System.IDisposable.Dispose" />.</param>
182+
<param name="disposing">If <see langword="true" />, is invoked from <see cref="M:System.IDisposable.Dispose" />.</param>
192183
<summary>Disposes the provider.</summary>
193184
<remarks>To be added.</remarks>
194185
</Docs>

0 commit comments

Comments
 (0)