Skip to content

Docs for Extensions: FileProviders and Hosting #4106

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 3 commits into from
Sep 2, 2020
Merged

Docs for Extensions: FileProviders and Hosting #4106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2796ee6
Docs for Extensions: FileProviders and Hosting
maryamariyan Apr 14, 2020
f836fab
Apply suggestions from code review
maryamariyan Sep 2, 2020
bc4c1c4
Merge remote-tracking branch 'origin/master' into ms-fileproviders-ho…
maryamariyan Sep 2, 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
16 changes: 12 additions & 4 deletions xml/Microsoft.Extensions.FileProviders.Composite/CompositeDirectoryContents.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="CompositeDirectoryContents" FullName="Microsoft.Extensions.FileProviders.Composite.CompositeDirectoryContents">
<Type Name="CompositeDirectoryContents" FullName="Microsoft.Extensions.FileProviders.Composite.CompositeDirectoryContents">
<TypeSignature Language="C#" Value="public class CompositeDirectoryContents : Microsoft.Extensions.FileProviders.IDirectoryContents, System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.FileProviders.IFileInfo&gt;" />
<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" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.Composite.CompositeDirectoryContents" />
Expand Down Expand Up @@ -158,9 +158,17 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Returns an enumerator that iterates through a collection.</summary>
<returns>An enumerator that can be used to iterate through the collection.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
</Docs>
</Member>
</Members>
Expand Down
16 changes: 12 additions & 4 deletions xml/Microsoft.Extensions.FileProviders.Embedded/EmbeddedResourceFileInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="EmbeddedResourceFileInfo" FullName="Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo">
<Type Name="EmbeddedResourceFileInfo" FullName="Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo">
<TypeSignature Language="C#" Value="public class EmbeddedResourceFileInfo : Microsoft.Extensions.FileProviders.IFileInfo" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EmbeddedResourceFileInfo extends System.Object implements class Microsoft.Extensions.FileProviders.IFileInfo" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo" />
Expand Down Expand Up @@ -87,9 +87,17 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Returns the file contents as a read-only stream.</summary>
<returns>A read-only stream.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The caller should dispose the stream when done with it.

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
Expand Down
24 changes: 16 additions & 8 deletions xml/Microsoft.Extensions.FileProviders.Internal/PhysicalDirectoryContents.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="PhysicalDirectoryContents" FullName="Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents">
<Type Name="PhysicalDirectoryContents" FullName="Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents">
<TypeSignature Language="C#" Value="public class PhysicalDirectoryContents : Microsoft.Extensions.FileProviders.IDirectoryContents, System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.FileProviders.IFileInfo&gt;" />
<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" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents" />
Expand Down Expand Up @@ -113,8 +113,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Determines if a directory was located at the given path.</summary>
<value><see langword="true" /> if a directory was located at the given path; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -145,8 +145,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns an enumerator that iterates through the collection.</summary>
<returns>An enumerator that can be used to iterate through the collection.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -177,9 +177,17 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Returns an enumerator that iterates through a collection.</summary>
<returns>An enumerator that can be used to iterate through the collection.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
</Docs>
</Member>
</Members>
Expand Down
14 changes: 7 additions & 7 deletions xml/Microsoft.Extensions.FileProviders.Physical/PhysicalDirectoryInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="PhysicalDirectoryInfo" FullName="Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo">
<Type Name="PhysicalDirectoryInfo" FullName="Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo">
<TypeSignature Language="C#" Value="public class PhysicalDirectoryInfo : Microsoft.Extensions.FileProviders.IFileInfo" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PhysicalDirectoryInfo extends System.Object implements class Microsoft.Extensions.FileProviders.IFileInfo" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo" />
Expand Down Expand Up @@ -116,8 +116,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Determines if the resource exists in the underlying storage system.</summary>
<value><see langword="true" /> if the resource exists in the underlying storage system; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -241,8 +241,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the name of the file or directory, excluding the path.</summary>
<value>A string representing the name of the file or directory.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -273,8 +273,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the full path to the file, including the file name.</summary>
<value>A string representing the full path to the file, or <see langword="null" /> if the file is not directly accessible.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down
29 changes: 18 additions & 11 deletions xml/Microsoft.Extensions.FileProviders.Physical/PhysicalFileInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="PhysicalFileInfo" FullName="Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo">
<Type Name="PhysicalFileInfo" FullName="Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo">
<TypeSignature Language="C#" Value="public class PhysicalFileInfo : Microsoft.Extensions.FileProviders.IFileInfo" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PhysicalFileInfo extends System.Object implements class Microsoft.Extensions.FileProviders.IFileInfo" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo" />
Expand Down Expand Up @@ -84,9 +84,16 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Returns the file contents as a read-only stream.</summary>
<returns>A read-only stream.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks

The caller should dispose the stream when done with it.

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
Expand Down Expand Up @@ -116,8 +123,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Determines if the resource exists in the underlying system.</summary>
<value><see langword="true" /> if the resource exists in the underlying storage system; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -179,8 +186,8 @@
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the last time the file was modified.</summary>
<value>A datetime offset representing the last time the file was modified.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -211,7 +218,7 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The length of the file in bytes, or -1 for a directory or non-existing files.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
Expand Down Expand Up @@ -243,7 +250,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The name of the file or directory, not including any path.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
Expand Down Expand Up @@ -275,7 +282,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The path to the file, including the file name. Return <see langword="null" /> if the file is not directly accessible.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
Expand Down
15 changes: 8 additions & 7 deletions xml/Microsoft.Extensions.FileProviders.Physical/PollingWildCardChangeToken.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="PollingWildCardChangeToken" FullName="Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken">
<Type Name="PollingWildCardChangeToken" FullName="Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken">
<TypeSignature Language="C#" Value="public class PollingWildCardChangeToken : Microsoft.Extensions.Primitives.IChangeToken" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PollingWildCardChangeToken extends System.Object implements class Microsoft.Extensions.Primitives.IChangeToken" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken" />
Expand Down Expand Up @@ -82,7 +82,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<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>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
Expand Down Expand Up @@ -144,7 +144,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets a value that indicates if a change has occurred.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
Expand Down Expand Up @@ -179,10 +179,11 @@
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="callback">To be added.</param>
<param name="state">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="callback">The <see cref="T:System.Action`1" /> to invoke.</param>
<param name="state">State to be passed into the callback.</param>
<summary>Registers for a callback that will be invoked when the entry has changed.
<see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> MUST be set before the callback is invoked.</summary>
<returns>An <see cref="T:System.IDisposable" /> that is used to unregister the callback.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
20 changes: 10 additions & 10 deletions xml/Microsoft.Extensions.FileProviders/ManifestEmbeddedFileProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="ManifestEmbeddedFileProvider" FullName="Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider">
<Type Name="ManifestEmbeddedFileProvider" FullName="Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider">
<TypeSignature Language="C#" Value="public class ManifestEmbeddedFileProvider : Microsoft.Extensions.FileProviders.IFileProvider" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ManifestEmbeddedFileProvider extends System.Object implements class Microsoft.Extensions.FileProviders.IFileProvider" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider" />
Expand Down Expand Up @@ -186,9 +186,9 @@
<Parameter Name="subpath" Type="System.String" />
</Parameters>
<Docs>
<param name="subpath">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="subpath">Relative path that identifies the directory.</param>
<summary>Enumerate a directory at the given path, if any.</summary>
<returns>Returns the contents of the directory.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -218,9 +218,9 @@
<Parameter Name="subpath" Type="System.String" />
</Parameters>
<Docs>
<param name="subpath">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="subpath">Relative path that identifies the file.</param>
<summary>Locate a file at the given path.</summary>
<returns>The file information. Caller must check Exists property.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -250,9 +250,9 @@
<Parameter Name="filter" Type="System.String" />
</Parameters>
<Docs>
<param name="filter">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="filter">Filter string used to determine what files or folders to monitor. Example: **/*.cs, *.*, subFolder/**/*.cshtml.</param>
<summary>Creates a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for the specified <paramref name="filter" />.</summary>
<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>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down
16 changes: 12 additions & 4 deletions xml/Microsoft.Extensions.FileProviders/NotFoundDirectoryContents.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="NotFoundDirectoryContents" FullName="Microsoft.Extensions.FileProviders.NotFoundDirectoryContents">
<Type Name="NotFoundDirectoryContents" FullName="Microsoft.Extensions.FileProviders.NotFoundDirectoryContents">
<TypeSignature Language="C#" Value="public class NotFoundDirectoryContents : Microsoft.Extensions.FileProviders.IDirectoryContents, System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.FileProviders.IFileInfo&gt;" />
<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" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents" />
Expand Down Expand Up @@ -176,9 +176,17 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Returns an enumerator that iterates through a collection.</summary>
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.FileProviders/NotFoundFileInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="NotFoundFileInfo" FullName="Microsoft.Extensions.FileProviders.NotFoundFileInfo">
<Type Name="NotFoundFileInfo" FullName="Microsoft.Extensions.FileProviders.NotFoundFileInfo">
<TypeSignature Language="C#" Value="public class NotFoundFileInfo : Microsoft.Extensions.FileProviders.IFileInfo" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NotFoundFileInfo extends System.Object implements class Microsoft.Extensions.FileProviders.IFileInfo" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo" />
Expand Down Expand Up @@ -240,7 +240,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The name of the file or directory, not including any path.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
Expand Down
Loading