Skip to content

Commit f5e4b7e

Browse files
authored
Document System.Configuration.Internal.DelegatingConfigHost (#3670)
* Document System.Configuration.Internal.DelegatingConfigHost * suggestion by JeremyKuhne * forInternalUseOnly * Update xml/System.Configuration.Internal/DelegatingConfigHost.xml
1 parent 8f27051 commit f5e4b7e

File tree

2 files changed

+27
-20
lines changed

2 files changed

+27
-20
lines changed

xml/System.Configuration.Internal/DelegatingConfigHost.xml

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -197,9 +197,9 @@
197197
</Parameters>
198198
<Docs>
199199
<param name="encryptedXml">An encrypted section of a configuration file.</param>
200-
<param name="protectionProvider">A <see cref="T:System.Configuration.ProtectedConfigurationProvider" /> object.</param>
201-
<param name="protectedConfigSection">A <see cref="T:System.Configuration.ProtectedConfigurationSection" /> object.</param>
202-
<param name="protectedSection">To be added.</param>
200+
<param name="protectionProvider">An object containing the providers that encrypt and decrypt protected configuration data.</param>
201+
<param name="protectedConfigSection">An object that provides programatic access to the <c>configProtectedData</c> configuration section.</param>
202+
<param name="protectedSection">An object that provides programatic access to the <c>configProtectedData</c> configuration section.</param>
203203
<summary>Decrypts an encrypted configuration section.</summary>
204204
<returns>A string representing a decrypted configuration section.</returns>
205205
<remarks>To be added.</remarks>
@@ -282,10 +282,10 @@
282282
</Parameters>
283283
<Docs>
284284
<param name="clearTextXml">A section of the configuration that is not encrypted.</param>
285-
<param name="encryptedXml">To be added.</param>
286-
<param name="protectionProvider">A <see cref="T:System.Configuration.ProtectedConfigurationProvider" /> object.</param>
287-
<param name="protectedConfigSection">A <see cref="T:System.Configuration.ProtectedConfigurationSection" /> object.</param>
288-
<param name="protectedSection">To be added.</param>
285+
<param name="encryptedXml">A section of the configuration that is not encrypted.</param>
286+
<param name="protectionProvider">An object containing the providers that encrypt and decrypt protected configuration data</param>
287+
<param name="protectedConfigSection">An object that provides programatic access to the <c>configProtectedData</c> configuration section.</param>
288+
<param name="protectedSection">An object that provides programatic access to the <c>configProtectedData</c> configuration section.</param>
289289
<summary>Encrypts a section of a configuration object.</summary>
290290
<returns>A string representing an encrypted section of the configuration object.</returns>
291291
<remarks>To be added.</remarks>
@@ -331,7 +331,7 @@
331331
<Docs>
332332
<param name="configPath">A string representing the path to a configuration file.</param>
333333
<param name="locationSubPath">A string representing a location subpath.</param>
334-
<param name="locatinSubPath">To be added.</param>
334+
<param name="locatinSubPath">A string representing a location subpath.</param>
335335
<summary>Returns a configuration path based on a location subpath.</summary>
336336
<returns>A string representing a configuration path.</returns>
337337
<remarks>To be added.</remarks>
@@ -589,9 +589,11 @@
589589
<ReturnType>System.Boolean</ReturnType>
590590
</ReturnValue>
591591
<Docs>
592-
<summary>To be added.</summary>
593-
<value>To be added.</value>
594-
<remarks>To be added.</remarks>
592+
<summary>Determines if the delegated host has a local configuration.</summary>
593+
<value>
594+
<see langword="true" /> if the current instance has a local configuration; otherwise, <see langword="false" />.</value>
595+
<remarks>To be added.</remarks>
596+
<forInternalUseOnly />
595597
</Docs>
596598
</Member>
597599
<Member MemberName="HasRoamingConfig">
@@ -615,9 +617,11 @@
615617
<ReturnType>System.Boolean</ReturnType>
616618
</ReturnValue>
617619
<Docs>
618-
<summary>To be added.</summary>
619-
<value>To be added.</value>
620-
<remarks>To be added.</remarks>
620+
<summary>Determines if the delegated host has a roaming configuration.</summary>
621+
<value>
622+
<see langword="true" /> if the current instance has a roaming configuration; otherwise, <see langword="false" />.</value>
623+
<remarks>To be added.</remarks>
624+
<forInternalUseOnly />
621625
</Docs>
622626
</Member>
623627
<Member MemberName="Host">
@@ -851,9 +855,11 @@
851855
<ReturnType>System.Boolean</ReturnType>
852856
</ReturnValue>
853857
<Docs>
854-
<summary>To be added.</summary>
855-
<value>To be added.</value>
856-
<remarks>To be added.</remarks>
858+
<summary>Determines if the application configuration file comes from a non-local URI (that is, <c>http://</c>) or is a local file.</summary>
859+
<value>
860+
<see langword="true" /> if the delegated host's sections belong to <c>System.Net</c> and the configuration file for the application is downloaded via HTTP using <see cref="T:System.Net.WebClient" />; otherwise, <see langword="false" />.</value>
861+
<remarks>To be added.</remarks>
862+
<forInternalUseOnly />
857863
</Docs>
858864
</Member>
859865
<Member MemberName="IsConfigRecordRequired">
@@ -1548,8 +1554,9 @@
15481554
</ReturnValue>
15491555
<Parameters />
15501556
<Docs>
1551-
<summary>To be added.</summary>
1552-
<remarks>To be added.</remarks>
1557+
<summary>Invokes the delegated host's method that refreshes configuration paths.</summary>
1558+
<remarks>To be added.</remarks>
1559+
<forInternalUseOnly />
15531560
</Docs>
15541561
</Member>
15551562
<Member MemberName="RequireCompleteInit">

xml/System.Configuration/ProtectedConfigurationProvider.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
</Base>
2323
<Interfaces />
2424
<Docs>
25-
<summary>Is the base class to create providers for encrypting and decrypting protected-configuration data.</summary>
25+
<summary>The base class to create providers for encrypting and decrypting protected configuration data.</summary>
2626
<remarks>
2727
<format type="text/markdown"><![CDATA[
2828

0 commit comments

Comments
 (0)