60d6d952cdbb9fe4094f90501f0a5e804955ecba
[platform/core/dotnet/build-tools.git] /
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Microsoft.Extensions.Configuration.KeyPerFile</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Microsoft.Extensions.Configuration.KeyPerFileConfigurationBuilderExtensions">\r
8             <summary>\r
9             Extension methods for registering <see cref="T:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider"/> with <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.\r
10             </summary>\r
11         </member>\r
12         <member name="M:Microsoft.Extensions.Configuration.KeyPerFileConfigurationBuilderExtensions.AddKeyPerFile(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">\r
13             <summary>\r
14             Adds configuration using files from a directory. File names are used as the key,\r
15             file contents are used as the value.\r
16             </summary>\r
17             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>\r
18             <param name="directoryPath">The path to the directory.</param>\r
19             <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>\r
20         </member>\r
21         <member name="M:Microsoft.Extensions.Configuration.KeyPerFileConfigurationBuilderExtensions.AddKeyPerFile(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String,System.Boolean)">\r
22             <summary>\r
23             Adds configuration using files from a directory. File names are used as the key,\r
24             file contents are used as the value.\r
25             </summary>\r
26             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>\r
27             <param name="directoryPath">The path to the directory.</param>\r
28             <param name="optional">Whether the directory is optional.</param>\r
29             <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>\r
30         </member>\r
31         <member name="M:Microsoft.Extensions.Configuration.KeyPerFileConfigurationBuilderExtensions.AddKeyPerFile(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String,System.Boolean,System.Boolean)">\r
32             <summary>\r
33             Adds configuration using files from a directory. File names are used as the key,\r
34             file contents are used as the value.\r
35             </summary>\r
36             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>\r
37             <param name="directoryPath">The path to the directory.</param>\r
38             <param name="optional">Whether the directory is optional.</param>\r
39             <param name="reloadOnChange">Whether the configuration should be reloaded if the files are changed, added or removed.</param>\r
40             <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>\r
41         </member>\r
42         <member name="M:Microsoft.Extensions.Configuration.KeyPerFileConfigurationBuilderExtensions.AddKeyPerFile(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource})">\r
43             <summary>\r
44             Adds configuration using files from a directory. File names are used as the key,\r
45             file contents are used as the value.\r
46             </summary>\r
47             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>\r
48             <param name="configureSource">Configures the source.</param>\r
49             <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>\r
50         </member>\r
51         <member name="T:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider">\r
52             <summary>\r
53             A <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider"/> that uses a directory's files as configuration key/values.\r
54             </summary>\r
55         </member>\r
56         <member name="M:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider.#ctor(Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource)">\r
57             <summary>\r
58             Initializes a new instance.\r
59             </summary>\r
60             <param name="source">The settings.</param>\r
61         </member>\r
62         <member name="M:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider.Load">\r
63             <summary>\r
64             Loads the configuration values.\r
65             </summary>\r
66         </member>\r
67         <member name="M:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider.ToString">\r
68             <summary>\r
69             Generates a string representing this provider name and relevant details.\r
70             </summary>\r
71             <returns>The configuration name.</returns>\r
72         </member>\r
73         <member name="M:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider.Dispose">\r
74             <inheritdoc />\r
75         </member>\r
76         <member name="T:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource">\r
77             <summary>\r
78             An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/> used to configure <see cref="T:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider"/>.\r
79             </summary>\r
80         </member>\r
81         <member name="M:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.#ctor">\r
82             <summary>\r
83             Constructor;\r
84             </summary>\r
85         </member>\r
86         <member name="P:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.FileProvider">\r
87             <summary>\r
88             The FileProvider whos root "/" directory files will be used as configuration data.\r
89             </summary>\r
90         </member>\r
91         <member name="P:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.IgnorePrefix">\r
92             <summary>\r
93             Files that start with this prefix will be excluded.\r
94             Defaults to "ignore.".\r
95             </summary>\r
96         </member>\r
97         <member name="P:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.IgnoreCondition">\r
98             <summary>\r
99             Used to determine if a file should be ignored using its name.\r
100             Defaults to using the IgnorePrefix.\r
101             </summary>\r
102         </member>\r
103         <member name="P:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.Optional">\r
104             <summary>\r
105             If false, will throw if the directory doesn't exist.\r
106             </summary>\r
107         </member>\r
108         <member name="P:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.ReloadOnChange">\r
109             <summary>\r
110             Determines whether the source will be loaded if the underlying file changes.\r
111             </summary>\r
112         </member>\r
113         <member name="P:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.ReloadDelay">\r
114             <summary>\r
115             Number of milliseconds that reload will wait before calling Load.  This helps\r
116             avoid triggering reload before a file is completely written. Default is 250.\r
117             </summary>\r
118         </member>\r
119         <member name="P:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.SectionDelimiter">\r
120             <summary>\r
121             The delimiter used to separate individual keys in a path.\r
122             </summary>\r
123             <value>Default is <c>__</c>.</value>\r
124         </member>\r
125         <member name="M:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">\r
126             <summary>\r
127             Builds the <see cref="T:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider"/> for this source.\r
128             </summary>\r
129             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>\r
130             <returns>A <see cref="T:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider"/></returns>\r
131         </member>\r
132     </members>\r
133 </doc>\r