Skip to content

Commit 58098e6

Browse files
bartonjsgewarren
authored andcommitted
Add missing documentation for the CryptographicOperations class. (#3476)
* Add missing documentation for the CryptographicOperations class. * which -> that * Apply suggestions from code review Co-Authored-By: Genevieve Warren <gewarren@microsoft.com>
1 parent 2395fb5 commit 58098e6

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

xml/System.Security.Cryptography/CryptographicOperations.xml

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
</Base>
1919
<Interfaces />
2020
<Docs>
21-
<summary>To be added.</summary>
21+
<summary>Provides methods for use in working with cryptography to reduce the risk of side-channel information leakage.</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -89,9 +89,18 @@ Fixed-time behavior is guaranteed in all other cases, including when `left` and
8989
<Parameter Name="buffer" Type="System.Span&lt;System.Byte&gt;" />
9090
</Parameters>
9191
<Docs>
92-
<param name="buffer">To be added.</param>
93-
<summary>To be added.</summary>
94-
<remarks>To be added.</remarks>
92+
<param name="buffer">The buffer to fill with zeros.</param>
93+
<summary>Fills the provided buffer with zeros.</summary>
94+
<remarks>
95+
<format type="text/markdown"><![CDATA[
96+
97+
## Remarks
98+
99+
This method exists to future-proof against potential optimizations in the .NET runtime that could eliminate memory writes that aren't followed by memory reads.
100+
While the C and C++ compilers have similar optimizations, no such optimizations are planned at this time for .NET.
101+
102+
]]></format>
103+
</remarks>
95104
</Docs>
96105
</Member>
97106
</Members>

0 commit comments

Comments
 (0)