Fill gaps in documentation (#465)

aws · Jul 30, 2024 · be61df4 · be61df4
1 parent dbc1e79
commit be61df4
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 1 deletion.
diff --git a/aws-lc-rs/src/agreement.rs b/aws-lc-rs/src/agreement.rs
@@ -562,6 +562,9 @@ impl Debug for PublicKey {
 }
 
 impl AsRef<[u8]> for PublicKey {
+    /// Serializes the public key in an uncompressed form (X9.62) using the
+    /// Octet-String-to-Elliptic-Curve-Point algorithm in
+    /// [SEC 1: Elliptic Curve Cryptography, Version 2.0].
     fn as_ref(&self) -> &[u8] {
         &self.public_key[0..self.len]
     }

diff --git a/aws-lc-rs/src/ed25519.rs b/aws-lc-rs/src/ed25519.rs
@@ -130,6 +130,7 @@ pub struct PublicKey([u8; ED25519_PUBLIC_KEY_LEN]);
 
 impl AsRef<[u8]> for PublicKey {
     #[inline]
+    /// Returns the "raw" bytes of the ED25519 public key
     fn as_ref(&self) -> &[u8] {
         &self.0
     }

diff --git a/aws-lc-rs/src/rsa/key.rs b/aws-lc-rs/src/rsa/key.rs
@@ -343,6 +343,7 @@ impl Debug for PublicKey {
 }
 
 impl AsRef<[u8]> for PublicKey {
+    /// DER encode a RSA public key to (RFC 8017) `RSAPublicKey` structure.
     fn as_ref(&self) -> &[u8] {
         self.key.as_ref()
     }

diff --git a/book/src/requirements/windows.md b/book/src/requirements/windows.md
@@ -4,7 +4,7 @@
 |---------------------------|--------------------------------------------|-----------------------------------------|-------------------|
 | `x86_64-pc-windows-msvc`  | C/C++ Compiler, CMake & NASM               | C/C++ Compiler, CMake, NASM, Go & Ninja | **_Yes_**         | 
 | `x86_64-pc-windows-gnu`   | C/C++ Compiler, CMake & NASM               | **Not Supported**                       | **_Yes_**         |
-| `aarch64-pc-windows-msvc` | C/C++ Compiler (`clang-cl`), CMake & Ninja | **Not Supported**                       | **_Yes_**         |
+| `aarch64-pc-windows-msvc` | C/C++ Compiler (MSVC's `clang-cl`) & CMake | **Not Supported**                       | **_Yes_**         |
 | _Other_                   | **Not Supported**                          | **Not Supported**                       | N/A               |
 
 ## C/C++ Compiler