Skip to content

Commit 6560aff

Browse files
authored
add docs for win32 registry (#4082)
1 parent af0894c commit 6560aff

File tree

7 files changed

+29
-23
lines changed

7 files changed

+29
-23
lines changed

xml/Microsoft.Win32.SafeHandles/SafeMemoryMappedFileHandle.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,9 @@
115115
<ReturnType>System.Boolean</ReturnType>
116116
</ReturnValue>
117117
<Docs>
118-
<summary>To be added.</summary>
119-
<value>To be added.</value>
118+
<summary>Gets a value that indicates whether the handle is invalid.</summary>
119+
<value>
120+
<see langword="true" /> if the handle is not valid; otherwise, <see langword="false" />.</value>
120121
<remarks>To be added.</remarks>
121122
</Docs>
122123
</Member>

xml/Microsoft.Win32.SafeHandles/SafeNCryptHandle.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,9 @@ Each open handle object can be thought of as being in one of three states:
158158
<ReturnType>System.Boolean</ReturnType>
159159
</ReturnValue>
160160
<Docs>
161-
<summary>To be added.</summary>
162-
<value>To be added.</value>
161+
<summary>Gets a value that indicates whether the handle is invalid.</summary>
162+
<value>
163+
<see langword="true" /> if the handle is not valid; otherwise, <see langword="false" />.</value>
163164
<remarks>To be added.</remarks>
164165
</Docs>
165166
</Member>

xml/Microsoft.Win32.SafeHandles/SafePipeHandle.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,9 @@
120120
<ReturnType>System.Boolean</ReturnType>
121121
</ReturnValue>
122122
<Docs>
123-
<summary>To be added.</summary>
124-
<value>To be added.</value>
123+
<summary>Gets a value that indicates whether the handle is invalid.</summary>
124+
<value>
125+
<see langword="true" /> if the handle is not valid; otherwise, <see langword="false" />.</value>
125126
<remarks>To be added.</remarks>
126127
</Docs>
127128
</Member>

xml/Microsoft.Win32.SafeHandles/SafeProcessHandle.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,9 @@
124124
<ReturnType>System.Boolean</ReturnType>
125125
</ReturnValue>
126126
<Docs>
127-
<summary>To be added.</summary>
128-
<value>To be added.</value>
127+
<summary>Gets a value that indicates whether the handle is invalid.</summary>
128+
<value>
129+
<see langword="true" /> if the handle is not valid; otherwise, <see langword="false" />.</value>
129130
<remarks>To be added.</remarks>
130131
</Docs>
131132
</Member>

xml/Microsoft.Win32.SafeHandles/SafeRegistryHandle.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,9 @@
127127
<ReturnType>System.Boolean</ReturnType>
128128
</ReturnValue>
129129
<Docs>
130-
<summary>To be added.</summary>
131-
<value>To be added.</value>
130+
<summary>Gets a value that indicates whether the handle is invalid.</summary>
131+
<value>
132+
<see langword="true" /> if the handle is not valid; otherwise, <see langword="false" />.</value>
132133
<remarks>To be added.</remarks>
133134
</Docs>
134135
</Member>

xml/Microsoft.Win32.SafeHandles/SafeX509ChainHandle.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,9 @@
107107
<ReturnType>System.Boolean</ReturnType>
108108
</ReturnValue>
109109
<Docs>
110-
<summary>To be added.</summary>
111-
<value>To be added.</value>
110+
<summary>Gets a value that indicates whether the handle is invalid.</summary>
111+
<value>
112+
<see langword="true" /> if the handle is not valid; otherwise, <see langword="false" />.</value>
112113
<remarks>To be added.</remarks>
113114
</Docs>
114115
</Member>

xml/Microsoft.Win32/RegistryAclExtensions.xml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
</Attribute>
2525
</Attributes>
2626
<Docs>
27-
<summary>To be added.</summary>
27+
<summary>Provides Windows-specific static extension methods for manipulating Access Control List (ACL) security attributes for registry keys.</summary>
2828
<remarks>To be added.</remarks>
2929
</Docs>
3030
<Members>
@@ -52,9 +52,9 @@
5252
<Parameter Name="key" Type="Microsoft.Win32.RegistryKey" RefType="this" />
5353
</Parameters>
5454
<Docs>
55-
<param name="key">To be added.</param>
56-
<summary>To be added.</summary>
57-
<returns>To be added.</returns>
55+
<param name="key">The existing registry key from which to obtain the security information.</param>
56+
<summary>Returns the security information of a registry key.</summary>
57+
<returns>The security descriptors of all the access control sections of the registry key.</returns>
5858
<remarks>To be added.</remarks>
5959
</Docs>
6060
</Member>
@@ -83,10 +83,10 @@
8383
<Parameter Name="includeSections" Type="System.Security.AccessControl.AccessControlSections" />
8484
</Parameters>
8585
<Docs>
86-
<param name="key">To be added.</param>
87-
<param name="includeSections">To be added.</param>
88-
<summary>To be added.</summary>
89-
<returns>To be added.</returns>
86+
<param name="key">An existing registry key from which to obtain the security information.</param>
87+
<param name="includeSections">The desired access control sections to retrieve.</param>
88+
<summary>Returns the security information of a registry key.</summary>
89+
<returns>The security descriptors of the specified access control sections of the registry key.</returns>
9090
<remarks>To be added.</remarks>
9191
</Docs>
9292
</Member>
@@ -115,9 +115,9 @@
115115
<Parameter Name="registrySecurity" Type="System.Security.AccessControl.RegistrySecurity" />
116116
</Parameters>
117117
<Docs>
118-
<param name="key">To be added.</param>
119-
<param name="registrySecurity">To be added.</param>
120-
<summary>To be added.</summary>
118+
<param name="key">An existing registry key.</param>
119+
<param name="registrySecurity">The security information to apply to the registry key.</param>
120+
<summary>Changes the security attributes of an existing registry key.</summary>
121121
<remarks>To be added.</remarks>
122122
</Docs>
123123
</Member>

0 commit comments

Comments
 (0)