Change all "Remark" notes to use the [!NOTE] blockquotes. (#126)

* Changed all "Remark" notes to use the [!NOTE] format. * Undo update to pubspec.lock
google · May 27, 2024 · 951879d · 951879d
1 parent 70f8a59
commit 951879d
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 8 deletions.
diff --git a/lib/src/webcrypto/webcrypto.aesctr.dart b/lib/src/webcrypto/webcrypto.aesctr.dart
@@ -168,11 +168,11 @@ abstract class AesCtrSecretKey {
   /// {@endtemplate}
   ///
   /// {@template AesCtrSecretKey-compatibility-notes}
-  /// **Remark** Firefox does not implement counter rollover for AES-CTR
-  /// correctly. Picking a sufficiently large [length] and using a [counter]
-  /// that isn't filled with `0xff` will likely avoid counter rollovers.
-  /// See [bug 1803105](https://bugzilla.mozilla.org/show_bug.cgi?id=1803105)
-  /// for details.
+  /// > [!NOTE]
+  /// > Firefox does not implement counter rollover for AES-CTR correctly. 
+  /// Picking a sufficiently large `length` and using a `counter` that isn't 
+  /// filled with 0xff will likely avoid counter rollovers. 
+  /// See [bug 1803105](https://bugzilla.mozilla.org/show_bug.cgi?id=1803105) for details.
   /// {@endtemplate}
   ///
   /// [1]: https://csrc.nist.gov/publications/detail/sp/800-38a/final

diff --git a/lib/src/webcrypto/webcrypto.aesgcm.dart b/lib/src/webcrypto/webcrypto.aesgcm.dart
@@ -202,7 +202,8 @@ abstract class AesGcmSecretKey {
   /// {@endtemplate}
   ///
   /// {@template AesGcmSecretKey-remark:no-stream-api}
-  /// **Remark** this package does not offer a streaming API for
+  /// > [!NOTE]
+  /// > This package does not offer a streaming API for
   /// encryption / decryption using AES-GCM, because reading deciphered
   /// plaintext prior to complete verification of the tag breaks the
   /// authenticity assurances. Specifically, until the entire message is
@@ -221,7 +222,7 @@ abstract class AesGcmSecretKey {
 
   // TODO: Document this method, notice that [data] must be concatenation of
   //       ciphertext and authentication tag.
-  // TODO: Document what happens if the authenticity validation fails? Some Exception? 
+  // TODO: Document what happens if the authenticity validation fails? Some Exception?
   Future<Uint8List> decryptBytes(
     List<int> data,
     List<int> iv, {

diff --git a/lib/src/webcrypto/webcrypto.dart b/lib/src/webcrypto/webcrypto.dart
@@ -62,7 +62,8 @@ abstract class KeyPair<S, T> {
 
 /// Elliptic curves supported by ECDSA and ECDH.
 ///
-/// **Remark**, additional values may be added to this enum in the future.
+/// > [!NOTE]
+/// > Additional values may be added to this enum in the future.
 enum EllipticCurve {
   p256,
   p384,