Skip to content

Commit b183ee2

Browse files
gewarrengewarren
authored
Unfilter Microsoft.Extensions.Hosting.Internal and Microsoft.Extensions.Internal (dotnet#6667)
1 parent 3ebac29 commit b183ee2

File tree

8 files changed

+226
-47
lines changed

8 files changed

+226
-47
lines changed

‎xml/Microsoft.Extensions.Hosting.Internal/ApplicationLifetime.xml‎

Lines changed: 81 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,17 @@
3232
</Interfaces>
3333
<Docs>
3434
<summary>Allows consumers to perform cleanup during a graceful shutdown.</summary>
35-
<remarks>To be added.</remarks>
35+
<remarks>
36+
<format type="text/markdown">
37+
<![CDATA[
38+
39+
## Remarks
40+
41+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
42+
43+
]]>
44+
</format>
45+
</remarks>
3646
</Docs>
3747
<Members>
3848
<Member MemberName=".ctor">
@@ -57,7 +67,7 @@
5767
</Parameters>
5868
<Docs>
5969
<param name="logger">To be added.</param>
60-
<summary>To be added.</summary>
70+
<summary>This API supports infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.</summary>
6171
<remarks>To be added.</remarks>
6272
</Docs>
6373
</Member>
@@ -86,10 +96,19 @@
8696
<ReturnType>System.Threading.CancellationToken</ReturnType>
8797
</ReturnValue>
8898
<Docs>
89-
<summary>Triggered when the application host has fully started and is about to wait
90-
for a graceful shutdown.</summary>
99+
<summary>Gets a cancellation token. Triggered when the application host has fully started and is about to wait for a graceful shutdown.</summary>
91100
<value>To be added.</value>
92-
<remarks>To be added.</remarks>
101+
<remarks>
102+
<format type="text/markdown">
103+
<![CDATA[
104+
105+
## Remarks
106+
107+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
108+
109+
]]>
110+
</format>
111+
</remarks>
93112
</Docs>
94113
</Member>
95114
<Member MemberName="ApplicationStopped">
@@ -117,11 +136,19 @@
117136
<ReturnType>System.Threading.CancellationToken</ReturnType>
118137
</ReturnValue>
119138
<Docs>
120-
<summary>Triggered when the application host is performing a graceful shutdown.
121-
All requests should be complete at this point. Shutdown will block
122-
until this event completes.</summary>
139+
<summary>Gets a cancellation token. Triggered when the application host is performing a graceful shutdown. All requests should be complete at this point. Shutdown will block until this event completes.</summary>
123140
<value>To be added.</value>
124-
<remarks>To be added.</remarks>
141+
<remarks>
142+
<format type="text/markdown">
143+
<![CDATA[
144+
145+
## Remarks
146+
147+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
148+
149+
]]>
150+
</format>
151+
</remarks>
125152
</Docs>
126153
</Member>
127154
<Member MemberName="ApplicationStopping">
@@ -149,10 +176,19 @@
149176
<ReturnType>System.Threading.CancellationToken</ReturnType>
150177
</ReturnValue>
151178
<Docs>
152-
<summary>Triggered when the application host is performing a graceful shutdown.
153-
Request may still be in flight. Shutdown will block until this event completes.</summary>
179+
<summary>Gets a cancellation token. Triggered when the application host is performing a graceful shutdown. Request may still be in flight. Shutdown will block until this event completes.</summary>
154180
<value>To be added.</value>
155-
<remarks>To be added.</remarks>
181+
<remarks>
182+
<format type="text/markdown">
183+
<![CDATA[
184+
185+
## Remarks
186+
187+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
188+
189+
]]>
190+
</format>
191+
</remarks>
156192
</Docs>
157193
</Member>
158194
<Member MemberName="NotifyStarted">
@@ -178,7 +214,17 @@
178214
<Parameters />
179215
<Docs>
180216
<summary>Signals the ApplicationStarted event and blocks until it completes.</summary>
181-
<remarks>To be added.</remarks>
217+
<remarks>
218+
<format type="text/markdown">
219+
<![CDATA[
220+
221+
## Remarks
222+
223+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
224+
225+
]]>
226+
</format>
227+
</remarks>
182228
</Docs>
183229
</Member>
184230
<Member MemberName="NotifyStopped">
@@ -204,7 +250,17 @@
204250
<Parameters />
205251
<Docs>
206252
<summary>Signals the ApplicationStopped event and blocks until it completes.</summary>
207-
<remarks>To be added.</remarks>
253+
<remarks>
254+
<format type="text/markdown">
255+
<![CDATA[
256+
257+
## Remarks
258+
259+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
260+
261+
]]>
262+
</format>
263+
</remarks>
208264
</Docs>
209265
</Member>
210266
<Member MemberName="StopApplication">
@@ -234,7 +290,17 @@
234290
<Parameters />
235291
<Docs>
236292
<summary>Signals the ApplicationStopping event and blocks until it completes.</summary>
237-
<remarks>To be added.</remarks>
293+
<remarks>
294+
<format type="text/markdown">
295+
<![CDATA[
296+
297+
## Remarks
298+
299+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
300+
301+
]]>
302+
</format>
303+
</remarks>
238304
</Docs>
239305
</Member>
240306
</Members>

‎xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml‎

Lines changed: 50 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,17 @@
2727
</Interfaces>
2828
<Docs>
2929
<summary>Listens for Ctrl+C or SIGTERM and initiates shutdown.</summary>
30-
<remarks>To be added.</remarks>
30+
<remarks>
31+
<format type="text/markdown">
32+
<![CDATA[
33+
34+
## Remarks
35+
36+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
37+
38+
]]>
39+
</format>
40+
</remarks>
3141
</Docs>
3242
<Members>
3343
<Member MemberName=".ctor">
@@ -52,7 +62,7 @@
5262
<param name="options">To be added.</param>
5363
<param name="environment">To be added.</param>
5464
<param name="applicationLifetime">To be added.</param>
55-
<summary>To be added.</summary>
65+
<summary>This API supports infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.</summary>
5666
<remarks>To be added.</remarks>
5767
</Docs>
5868
</Member>
@@ -82,7 +92,7 @@
8292
<param name="environment">To be added.</param>
8393
<param name="applicationLifetime">To be added.</param>
8494
<param name="hostOptions">To be added.</param>
85-
<summary>To be added.</summary>
95+
<summary>This API supports infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.</summary>
8696
<remarks>To be added.</remarks>
8797
</Docs>
8898
</Member>
@@ -114,7 +124,7 @@
114124
<param name="applicationLifetime">To be added.</param>
115125
<param name="hostOptions">To be added.</param>
116126
<param name="loggerFactory">To be added.</param>
117-
<summary>To be added.</summary>
127+
<summary>This API supports infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.</summary>
118128
<remarks>To be added.</remarks>
119129
</Docs>
120130
</Member>
@@ -144,7 +154,17 @@
144154
<Parameters />
145155
<Docs>
146156
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
147-
<remarks>To be added.</remarks>
157+
<remarks>
158+
<format type="text/markdown">
159+
<![CDATA[
160+
161+
## Remarks
162+
163+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
164+
165+
]]>
166+
</format>
167+
</remarks>
148168
</Docs>
149169
</Member>
150170
<Member MemberName="StopAsync">
@@ -176,8 +196,18 @@
176196
<Docs>
177197
<param name="cancellationToken">Used to indicate when stop should no longer be graceful.</param>
178198
<summary>Called from <see cref="M:Microsoft.Extensions.Hosting.IHost.StopAsync(System.Threading.CancellationToken)" /> to indicate that the host is stopping and it's time to shut down.</summary>
179-
<returns>A <see cref="T:System.Threading.Tasks.Task" />.</returns>
180-
<remarks>To be added.</remarks>
199+
<returns>To be added.</returns>
200+
<remarks>
201+
<format type="text/markdown">
202+
<![CDATA[
203+
204+
## Remarks
205+
206+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
207+
208+
]]>
209+
</format>
210+
</remarks>
181211
</Docs>
182212
</Member>
183213
<Member MemberName="WaitForStartAsync">
@@ -208,9 +238,19 @@
208238
</Parameters>
209239
<Docs>
210240
<param name="cancellationToken">Used to indicate when stop should no longer be graceful.</param>
211-
<summary>Called at the start of <see cref="M:Microsoft.Extensions.Hosting.IHost.StartAsync(System.Threading.CancellationToken)" /> which will wait until it's complete before continuing. This can be used to delay startup until signaled by an external event.</summary>
212-
<returns>A <see cref="T:System.Threading.Tasks.Task" />.</returns>
213-
<remarks>To be added.</remarks>
241+
<summary>Called at the start of <see cref="M:Microsoft.Extensions.Hosting.IHost.StartAsync(System.Threading.CancellationToken)" />, which will wait until it's complete before continuing. This can be used to delay startup until signaled by an external event.</summary>
242+
<returns>To be added.</returns>
243+
<remarks>
244+
<format type="text/markdown">
245+
<![CDATA[
246+
247+
## Remarks
248+
249+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
250+
251+
]]>
252+
</format>
253+
</remarks>
214254
</Docs>
215255
</Member>
216256
</Members>

‎xml/Microsoft.Extensions.Hosting.Internal/HostingEnvironment.xml‎

Lines changed: 46 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@
3232
</Interface>
3333
</Interfaces>
3434
<Docs>
35-
<summary>This API supports infrastructure and is not intended to be used
36-
directly from your code. This API may change or be removed in future releases.</summary>
35+
<summary>This API supports infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.</summary>
3736
<remarks>To be added.</remarks>
3837
</Docs>
3938
<Members>
@@ -55,7 +54,7 @@
5554
</AssemblyInfo>
5655
<Parameters />
5756
<Docs>
58-
<summary>To be added.</summary>
57+
<summary>This API supports infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.</summary>
5958
<remarks>To be added.</remarks>
6059
</Docs>
6160
</Member>
@@ -86,7 +85,17 @@
8685
<Docs>
8786
<summary>Gets or sets the name of the application. This property is automatically set by the host to the assembly containing the application entry point.</summary>
8887
<value>To be added.</value>
89-
<remarks>To be added.</remarks>
88+
<remarks>
89+
<format type="text/markdown">
90+
<![CDATA[
91+
92+
## Remarks
93+
94+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
95+
96+
]]>
97+
</format>
98+
</remarks>
9099
</Docs>
91100
</Member>
92101
<Member MemberName="ContentRootFileProvider">
@@ -116,7 +125,17 @@
116125
<Docs>
117126
<summary>Gets or sets an <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider" /> pointing at <see cref="P:Microsoft.Extensions.Hosting.IHostingEnvironment.ContentRootPath" />.</summary>
118127
<value>To be added.</value>
119-
<remarks>To be added.</remarks>
128+
<remarks>
129+
<format type="text/markdown">
130+
<![CDATA[
131+
132+
## Remarks
133+
134+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
135+
136+
]]>
137+
</format>
138+
</remarks>
120139
</Docs>
121140
</Member>
122141
<Member MemberName="ContentRootPath">
@@ -146,7 +165,17 @@
146165
<Docs>
147166
<summary>Gets or sets the absolute path to the directory that contains the application content files.</summary>
148167
<value>To be added.</value>
149-
<remarks>To be added.</remarks>
168+
<remarks>
169+
<format type="text/markdown">
170+
<![CDATA[
171+
172+
## Remarks
173+
174+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
175+
176+
]]>
177+
</format>
178+
</remarks>
150179
</Docs>
151180
</Member>
152181
<Member MemberName="EnvironmentName">
@@ -176,7 +205,17 @@
176205
<Docs>
177206
<summary>Gets or sets the name of the environment. The host automatically sets this property to the value of the of the "environment" key as specified in configuration.</summary>
178207
<value>To be added.</value>
179-
<remarks>To be added.</remarks>
208+
<remarks>
209+
<format type="text/markdown">
210+
<![CDATA[
211+
212+
## Remarks
213+
214+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
215+
216+
]]>
217+
</format>
218+
</remarks>
180219
</Docs>
181220
</Member>
182221
</Members>

‎xml/Microsoft.Extensions.Internal/ISystemClock.xml‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,17 @@
2020
<Interfaces />
2121
<Docs>
2222
<summary>Abstracts the system clock to facilitate testing.</summary>
23-
<remarks>To be added.</remarks>
23+
<remarks>
24+
<format type="text/markdown">
25+
<![CDATA[
26+
27+
## Remarks
28+
29+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
30+
31+
]]>
32+
</format>
33+
</remarks>
2434
</Docs>
2535
<Members>
2636
<Member MemberName="UtcNow">
@@ -47,9 +57,19 @@
4757
<ReturnType>System.DateTimeOffset</ReturnType>
4858
</ReturnValue>
4959
<Docs>
50-
<summary>Retrieves the current system time in UTC.</summary>
60+
<summary>Gets the current system time in UTC.</summary>
5161
<value>To be added.</value>
52-
<remarks>To be added.</remarks>
62+
<remarks>
63+
<format type="text/markdown">
64+
<![CDATA[
65+
66+
## Remarks
67+
68+
This API supports the .NET infrastructure and is not intended to be used directly from your code.
69+
70+
]]>
71+
</format>
72+
</remarks>
5373
</Docs>
5474
</Member>
5575
</Members>

0 commit comments

Comments
 (0)