Skip to content

Commit 951879d

Browse files
authored
Change all "Remark" notes to use the [!NOTE] blockquotes. (#126)
* Changed all "Remark" notes to use the [!NOTE] format. * Undo update to pubspec.lock
1 parent 70f8a59 commit 951879d

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

lib/src/webcrypto/webcrypto.aesctr.dart

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -168,11 +168,11 @@ abstract class AesCtrSecretKey {
168168
/// {@endtemplate}
169169
///
170170
/// {@template AesCtrSecretKey-compatibility-notes}
171-
/// **Remark** Firefox does not implement counter rollover for AES-CTR
172-
/// correctly. Picking a sufficiently large [length] and using a [counter]
173-
/// that isn't filled with `0xff` will likely avoid counter rollovers.
174-
/// See [bug 1803105](https://bugzilla.mozilla.org/show_bug.cgi?id=1803105)
175-
/// for details.
171+
/// > [!NOTE]
172+
/// > Firefox does not implement counter rollover for AES-CTR correctly.
173+
/// Picking a sufficiently large `length` and using a `counter` that isn't
174+
/// filled with 0xff will likely avoid counter rollovers.
175+
/// See [bug 1803105](https://bugzilla.mozilla.org/show_bug.cgi?id=1803105) for details.
176176
/// {@endtemplate}
177177
///
178178
/// [1]: https://csrc.nist.gov/publications/detail/sp/800-38a/final

lib/src/webcrypto/webcrypto.aesgcm.dart

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,8 @@ abstract class AesGcmSecretKey {
202202
/// {@endtemplate}
203203
///
204204
/// {@template AesGcmSecretKey-remark:no-stream-api}
205-
/// **Remark** this package does not offer a streaming API for
205+
/// > [!NOTE]
206+
/// > This package does not offer a streaming API for
206207
/// encryption / decryption using AES-GCM, because reading deciphered
207208
/// plaintext prior to complete verification of the tag breaks the
208209
/// authenticity assurances. Specifically, until the entire message is
@@ -221,7 +222,7 @@ abstract class AesGcmSecretKey {
221222

222223
// TODO: Document this method, notice that [data] must be concatenation of
223224
// ciphertext and authentication tag.
224-
// TODO: Document what happens if the authenticity validation fails? Some Exception?
225+
// TODO: Document what happens if the authenticity validation fails? Some Exception?
225226
Future<Uint8List> decryptBytes(
226227
List<int> data,
227228
List<int> iv, {

lib/src/webcrypto/webcrypto.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ abstract class KeyPair<S, T> {
6262

6363
/// Elliptic curves supported by ECDSA and ECDH.
6464
///
65-
/// **Remark**, additional values may be added to this enum in the future.
65+
/// > [!NOTE]
66+
/// > Additional values may be added to this enum in the future.
6667
enum EllipticCurve {
6768
p256,
6869
p384,

0 commit comments

Comments
 (0)