Skip to content

Commit 1dcffe9

Browse files
maryamariyancarlossanlop
maryamariyan
and
carlossanlop
authored
Docs for Extensions: FileProviders and Hosting (#4106)
* Docs for Extensions: FileProviders and Hosting * Apply suggestions from code review Applied PR feedback. Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>
1 parent 299da9f commit 1dcffe9

File tree

13 files changed

+115
-76
lines changed

13 files changed

+115
-76
lines changed

‎xml/Microsoft.Extensions.FileProviders.Composite/CompositeDirectoryContents.xml‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="CompositeDirectoryContents" FullName="Microsoft.Extensions.FileProviders.Composite.CompositeDirectoryContents">
1+
<Type Name="CompositeDirectoryContents" FullName="Microsoft.Extensions.FileProviders.Composite.CompositeDirectoryContents">
22
<TypeSignature Language="C#" Value="public class CompositeDirectoryContents : Microsoft.Extensions.FileProviders.IDirectoryContents, System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.FileProviders.IFileInfo&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CompositeDirectoryContents extends System.Object implements class Microsoft.Extensions.FileProviders.IDirectoryContents, class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Extensions.FileProviders.IFileInfo&gt;, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.Composite.CompositeDirectoryContents" />
@@ -158,9 +158,17 @@
158158
</ReturnValue>
159159
<Parameters />
160160
<Docs>
161-
<summary>To be added.</summary>
162-
<returns>To be added.</returns>
163-
<remarks>To be added.</remarks>
161+
<summary>Returns an enumerator that iterates through a collection.</summary>
162+
<returns>An enumerator that can be used to iterate through the collection.</returns>
163+
<remarks>
164+
<format type="text/markdown"><![CDATA[
165+
166+
## Remarks
167+
168+
This member is an explicit interface member implementation. It can be used only when the <xref:Microsoft.Extensions.FileProviders.Composite.CompositeDirectoryContents> instance is cast to an <xref:System.Collections.IEnumerable> interface.
169+
170+
]]></format>
171+
</remarks>
164172
</Docs>
165173
</Member>
166174
</Members>

‎xml/Microsoft.Extensions.FileProviders.Embedded/EmbeddedResourceFileInfo.xml‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="EmbeddedResourceFileInfo" FullName="Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo">
1+
<Type Name="EmbeddedResourceFileInfo" FullName="Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo">
22
<TypeSignature Language="C#" Value="public class EmbeddedResourceFileInfo : Microsoft.Extensions.FileProviders.IFileInfo" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EmbeddedResourceFileInfo extends System.Object implements class Microsoft.Extensions.FileProviders.IFileInfo" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo" />
@@ -87,9 +87,17 @@
8787
</ReturnValue>
8888
<Parameters />
8989
<Docs>
90-
<summary>To be added.</summary>
91-
<returns>To be added.</returns>
92-
<remarks>To be added.</remarks>
90+
<summary>Returns the file contents as a read-only stream.</summary>
91+
<returns>A read-only stream.</returns>
92+
<remarks>
93+
<format type="text/markdown"><![CDATA[
94+
95+
## Remarks
96+
97+
The caller should dispose the stream when done with it.
98+
99+
]]></format>
100+
</remarks>
93101
<inheritdoc />
94102
</Docs>
95103
</Member>

‎xml/Microsoft.Extensions.FileProviders.Internal/PhysicalDirectoryContents.xml‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="PhysicalDirectoryContents" FullName="Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents">
1+
<Type Name="PhysicalDirectoryContents" FullName="Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents">
22
<TypeSignature Language="C#" Value="public class PhysicalDirectoryContents : Microsoft.Extensions.FileProviders.IDirectoryContents, System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.FileProviders.IFileInfo&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PhysicalDirectoryContents extends System.Object implements class Microsoft.Extensions.FileProviders.IDirectoryContents, class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Extensions.FileProviders.IFileInfo&gt;, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents" />
@@ -113,8 +113,8 @@
113113
<ReturnType>System.Boolean</ReturnType>
114114
</ReturnValue>
115115
<Docs>
116-
<summary>To be added.</summary>
117-
<value>To be added.</value>
116+
<summary>Determines if a directory was located at the given path.</summary>
117+
<value><see langword="true" /> if a directory was located at the given path; <see langword="false" /> otherwise.</value>
118118
<remarks>To be added.</remarks>
119119
<inheritdoc />
120120
</Docs>
@@ -145,8 +145,8 @@
145145
</ReturnValue>
146146
<Parameters />
147147
<Docs>
148-
<summary>To be added.</summary>
149-
<returns>To be added.</returns>
148+
<summary>Returns an enumerator that iterates through the collection.</summary>
149+
<returns>An enumerator that can be used to iterate through the collection.</returns>
150150
<remarks>To be added.</remarks>
151151
<inheritdoc />
152152
</Docs>
@@ -177,9 +177,17 @@
177177
</ReturnValue>
178178
<Parameters />
179179
<Docs>
180-
<summary>To be added.</summary>
181-
<returns>To be added.</returns>
182-
<remarks>To be added.</remarks>
180+
<summary>Returns an enumerator that iterates through a collection.</summary>
181+
<returns>An enumerator that can be used to iterate through the collection.</returns>
182+
<remarks>
183+
<format type="text/markdown"><![CDATA[
184+
185+
## Remarks
186+
187+
This member is an explicit interface member implementation. It can be used only when the <xref:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents> instance is cast to an <xref:System.Collections.IEnumerable> interface.
188+
189+
]]></format>
190+
</remarks>
183191
</Docs>
184192
</Member>
185193
</Members>

‎xml/Microsoft.Extensions.FileProviders.Physical/PhysicalDirectoryInfo.xml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="PhysicalDirectoryInfo" FullName="Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo">
1+
<Type Name="PhysicalDirectoryInfo" FullName="Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo">
22
<TypeSignature Language="C#" Value="public class PhysicalDirectoryInfo : Microsoft.Extensions.FileProviders.IFileInfo" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PhysicalDirectoryInfo extends System.Object implements class Microsoft.Extensions.FileProviders.IFileInfo" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo" />
@@ -116,8 +116,8 @@
116116
<ReturnType>System.Boolean</ReturnType>
117117
</ReturnValue>
118118
<Docs>
119-
<summary>To be added.</summary>
120-
<value>To be added.</value>
119+
<summary>Determines if the resource exists in the underlying storage system.</summary>
120+
<value><see langword="true" /> if the resource exists in the underlying storage system; <see langword="false" /> otherwise.</value>
121121
<remarks>To be added.</remarks>
122122
<inheritdoc />
123123
</Docs>
@@ -241,8 +241,8 @@
241241
<ReturnType>System.String</ReturnType>
242242
</ReturnValue>
243243
<Docs>
244-
<summary>To be added.</summary>
245-
<value>To be added.</value>
244+
<summary>Gets the name of the file or directory, excluding the path.</summary>
245+
<value>A string representing the name of the file or directory.</value>
246246
<remarks>To be added.</remarks>
247247
<inheritdoc />
248248
</Docs>
@@ -273,8 +273,8 @@
273273
<ReturnType>System.String</ReturnType>
274274
</ReturnValue>
275275
<Docs>
276-
<summary>To be added.</summary>
277-
<value>To be added.</value>
276+
<summary>Gets the full path to the file, including the file name.</summary>
277+
<value>A string representing the full path to the file, or <see langword="null" /> if the file is not directly accessible.</value>
278278
<remarks>To be added.</remarks>
279279
<inheritdoc />
280280
</Docs>

‎xml/Microsoft.Extensions.FileProviders.Physical/PhysicalFileInfo.xml‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="PhysicalFileInfo" FullName="Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo">
1+
<Type Name="PhysicalFileInfo" FullName="Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo">
22
<TypeSignature Language="C#" Value="public class PhysicalFileInfo : Microsoft.Extensions.FileProviders.IFileInfo" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PhysicalFileInfo extends System.Object implements class Microsoft.Extensions.FileProviders.IFileInfo" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo" />
@@ -84,9 +84,16 @@
8484
</ReturnValue>
8585
<Parameters />
8686
<Docs>
87-
<summary>To be added.</summary>
88-
<returns>To be added.</returns>
89-
<remarks>To be added.</remarks>
87+
<summary>Returns the file contents as a read-only stream.</summary>
88+
<returns>A read-only stream.</returns>
89+
<remarks>
90+
<format type="text/markdown"><![CDATA[
91+
## Remarks
92+
93+
The caller should dispose the stream when done with it.
94+
95+
]]></format>
96+
</remarks>
9097
<inheritdoc />
9198
</Docs>
9299
</Member>
@@ -116,8 +123,8 @@
116123
<ReturnType>System.Boolean</ReturnType>
117124
</ReturnValue>
118125
<Docs>
119-
<summary>To be added.</summary>
120-
<value>To be added.</value>
126+
<summary>Determines if the resource exists in the underlying system.</summary>
127+
<value><see langword="true" /> if the resource exists in the underlying storage system; <see langword="false" /> otherwise.</value>
121128
<remarks>To be added.</remarks>
122129
<inheritdoc />
123130
</Docs>
@@ -179,8 +186,8 @@
179186
<ReturnType>System.DateTimeOffset</ReturnType>
180187
</ReturnValue>
181188
<Docs>
182-
<summary>To be added.</summary>
183-
<value>To be added.</value>
189+
<summary>Gets the last time the file was modified.</summary>
190+
<value>A datetime offset representing the last time the file was modified.</value>
184191
<remarks>To be added.</remarks>
185192
<inheritdoc />
186193
</Docs>
@@ -211,7 +218,7 @@
211218
<ReturnType>System.Int64</ReturnType>
212219
</ReturnValue>
213220
<Docs>
214-
<summary>To be added.</summary>
221+
<summary>The length of the file in bytes, or -1 for a directory or non-existing files.</summary>
215222
<value>To be added.</value>
216223
<remarks>To be added.</remarks>
217224
<inheritdoc />
@@ -243,7 +250,7 @@
243250
<ReturnType>System.String</ReturnType>
244251
</ReturnValue>
245252
<Docs>
246-
<summary>To be added.</summary>
253+
<summary>The name of the file or directory, not including any path.</summary>
247254
<value>To be added.</value>
248255
<remarks>To be added.</remarks>
249256
<inheritdoc />
@@ -275,7 +282,7 @@
275282
<ReturnType>System.String</ReturnType>
276283
</ReturnValue>
277284
<Docs>
278-
<summary>To be added.</summary>
285+
<summary>The path to the file, including the file name. Return <see langword="null" /> if the file is not directly accessible.</summary>
279286
<value>To be added.</value>
280287
<remarks>To be added.</remarks>
281288
<inheritdoc />

‎xml/Microsoft.Extensions.FileProviders.Physical/PollingWildCardChangeToken.xml‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="PollingWildCardChangeToken" FullName="Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken">
1+
<Type Name="PollingWildCardChangeToken" FullName="Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken">
22
<TypeSignature Language="C#" Value="public class PollingWildCardChangeToken : Microsoft.Extensions.Primitives.IChangeToken" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PollingWildCardChangeToken extends System.Object implements class Microsoft.Extensions.Primitives.IChangeToken" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken" />
@@ -82,7 +82,7 @@
8282
<ReturnType>System.Boolean</ReturnType>
8383
</ReturnValue>
8484
<Docs>
85-
<summary>To be added.</summary>
85+
<summary>Indicates if this token will pro-actively raise callbacks. If <see langword="false" />, the token consumer must poll <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> to detect changes.</summary>
8686
<value>To be added.</value>
8787
<remarks>To be added.</remarks>
8888
<inheritdoc />
@@ -144,7 +144,7 @@
144144
<ReturnType>System.Boolean</ReturnType>
145145
</ReturnValue>
146146
<Docs>
147-
<summary>To be added.</summary>
147+
<summary>Gets a value that indicates if a change has occurred.</summary>
148148
<value>To be added.</value>
149149
<remarks>To be added.</remarks>
150150
<inheritdoc />
@@ -179,10 +179,11 @@
179179
<Parameter Name="state" Type="System.Object" />
180180
</Parameters>
181181
<Docs>
182-
<param name="callback">To be added.</param>
183-
<param name="state">To be added.</param>
184-
<summary>To be added.</summary>
185-
<returns>To be added.</returns>
182+
<param name="callback">The <see cref="T:System.Action`1" /> to invoke.</param>
183+
<param name="state">State to be passed into the callback.</param>
184+
<summary>Registers for a callback that will be invoked when the entry has changed.
185+
<see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> MUST be set before the callback is invoked.</summary>
186+
<returns>An <see cref="T:System.IDisposable" /> that is used to unregister the callback.</returns>
186187
<remarks>To be added.</remarks>
187188
</Docs>
188189
</Member>

‎xml/Microsoft.Extensions.FileProviders/ManifestEmbeddedFileProvider.xml‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="ManifestEmbeddedFileProvider" FullName="Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider">
1+
<Type Name="ManifestEmbeddedFileProvider" FullName="Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider">
22
<TypeSignature Language="C#" Value="public class ManifestEmbeddedFileProvider : Microsoft.Extensions.FileProviders.IFileProvider" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ManifestEmbeddedFileProvider extends System.Object implements class Microsoft.Extensions.FileProviders.IFileProvider" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider" />
@@ -186,9 +186,9 @@
186186
<Parameter Name="subpath" Type="System.String" />
187187
</Parameters>
188188
<Docs>
189-
<param name="subpath">To be added.</param>
190-
<summary>To be added.</summary>
191-
<returns>To be added.</returns>
189+
<param name="subpath">Relative path that identifies the directory.</param>
190+
<summary>Enumerate a directory at the given path, if any.</summary>
191+
<returns>Returns the contents of the directory.</returns>
192192
<remarks>To be added.</remarks>
193193
<inheritdoc />
194194
</Docs>
@@ -218,9 +218,9 @@
218218
<Parameter Name="subpath" Type="System.String" />
219219
</Parameters>
220220
<Docs>
221-
<param name="subpath">To be added.</param>
222-
<summary>To be added.</summary>
223-
<returns>To be added.</returns>
221+
<param name="subpath">Relative path that identifies the file.</param>
222+
<summary>Locate a file at the given path.</summary>
223+
<returns>The file information. Caller must check Exists property.</returns>
224224
<remarks>To be added.</remarks>
225225
<inheritdoc />
226226
</Docs>
@@ -250,9 +250,9 @@
250250
<Parameter Name="filter" Type="System.String" />
251251
</Parameters>
252252
<Docs>
253-
<param name="filter">To be added.</param>
254-
<summary>To be added.</summary>
255-
<returns>To be added.</returns>
253+
<param name="filter">Filter string used to determine what files or folders to monitor. Example: **/*.cs, *.*, subFolder/**/*.cshtml.</param>
254+
<summary>Creates a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for the specified <paramref name="filter" />.</summary>
255+
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> that is notified when a file matching <paramref name="filter" /> is added, modified or deleted.</returns>
256256
<remarks>To be added.</remarks>
257257
<inheritdoc />
258258
</Docs>

‎xml/Microsoft.Extensions.FileProviders/NotFoundDirectoryContents.xml‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="NotFoundDirectoryContents" FullName="Microsoft.Extensions.FileProviders.NotFoundDirectoryContents">
1+
<Type Name="NotFoundDirectoryContents" FullName="Microsoft.Extensions.FileProviders.NotFoundDirectoryContents">
22
<TypeSignature Language="C#" Value="public class NotFoundDirectoryContents : Microsoft.Extensions.FileProviders.IDirectoryContents, System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.FileProviders.IFileInfo&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NotFoundDirectoryContents extends System.Object implements class Microsoft.Extensions.FileProviders.IDirectoryContents, class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Extensions.FileProviders.IFileInfo&gt;, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents" />
@@ -176,9 +176,17 @@
176176
</ReturnValue>
177177
<Parameters />
178178
<Docs>
179-
<summary>To be added.</summary>
180-
<returns>To be added.</returns>
181-
<remarks>To be added.</remarks>
179+
<summary>Returns an enumerator that iterates through a collection.</summary>
180+
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
181+
<remarks>
182+
<format type="text/markdown"><![CDATA[
183+
184+
## Remarks
185+
186+
This member is an explicit interface member implementation. It can be used only when the <xref:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents> instance is cast to an <xref:System.Collections.IEnumerable> interface.
187+
188+
]]></format>
189+
</remarks>
182190
<inheritdoc />
183191
</Docs>
184192
</Member>

‎xml/Microsoft.Extensions.FileProviders/NotFoundFileInfo.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="NotFoundFileInfo" FullName="Microsoft.Extensions.FileProviders.NotFoundFileInfo">
1+
<Type Name="NotFoundFileInfo" FullName="Microsoft.Extensions.FileProviders.NotFoundFileInfo">
22
<TypeSignature Language="C#" Value="public class NotFoundFileInfo : Microsoft.Extensions.FileProviders.IFileInfo" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NotFoundFileInfo extends System.Object implements class Microsoft.Extensions.FileProviders.IFileInfo" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo" />
@@ -240,7 +240,7 @@
240240
<ReturnType>System.String</ReturnType>
241241
</ReturnValue>
242242
<Docs>
243-
<summary>To be added.</summary>
243+
<summary>The name of the file or directory, not including any path.</summary>
244244
<value>To be added.</value>
245245
<remarks>To be added.</remarks>
246246
<inheritdoc />

0 commit comments

Comments
 (0)