From d2b6e3cd703c7a0df191845d7674712ccd8d7cf1 Mon Sep 17 00:00:00 2001 From: Zack Schuster Date: Tue, 14 Jun 2022 10:13:54 -0700 Subject: [PATCH] chore: use @note jsdoc tag --- smtp/client.ts | 2 +- smtp/connection.ts | 4 ++-- smtp/mime.ts | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/smtp/client.ts b/smtp/client.ts index d9c2f38..89e86f7 100644 --- a/smtp/client.ts +++ b/smtp/client.ts @@ -33,7 +33,7 @@ export class SMTPClient { /** * Create a standard SMTP client backed by a self-managed SMTP connection. * - * NOTE: `host` is trimmed before being used to establish a connection; however, the original untrimmed value will still be visible in configuration. + * @note `host` is trimmed before being used to establish a connection; however, the original untrimmed value will still be visible in configuration. * * @param {Partial} server smtp options */ diff --git a/smtp/connection.ts b/smtp/connection.ts index 5e071e5..d4ad11d 100644 --- a/smtp/connection.ts +++ b/smtp/connection.ts @@ -125,7 +125,7 @@ export class SMTPConnection extends EventEmitter { * * To target a Message Transfer Agent (MTA), omit all options. * - * NOTE: `host` is trimmed before being used to establish a connection; however, the original untrimmed value will still be visible in configuration. + * @note `host` is trimmed before being used to establish a connection; however, the original untrimmed value will still be visible in configuration. * * @param {Partial} options */ @@ -219,7 +219,7 @@ export class SMTPConnection extends EventEmitter { /** * Establish an SMTP connection. * - * NOTE: `host` is trimmed before being used to establish a connection; however, the original untrimmed value will still be visible in configuration. + * @note `host` is trimmed before being used to establish a connection; however, the original untrimmed value will still be visible in configuration. * * @public * @param {SMTPCommandCallback} callback diff --git a/smtp/mime.ts b/smtp/mime.ts index d7d9b3c..3955932 100644 --- a/smtp/mime.ts +++ b/smtp/mime.ts @@ -130,7 +130,7 @@ function checkRanges(nr: number) { * byte value in hex. This function only escapes character sequences; it does not * convert linebreaks etc. * - * NOTE: Encoding support depends on `util.TextDecoder`, which lacks full ICU support + * @note Encoding support depends on `util.TextDecoder`, which lacks full ICU support * prior to Node.js 13. * * @see https://nodejs.org/api/util.html#util_whatwg_supported_encodings @@ -168,7 +168,7 @@ export function mimeEncode(data: string | Uint8Array = '', encoding = 'utf-8') { /** * Encodes a string or an Uint8Array to an UTF-8 MIME Word * - * NOTE: Encoding support depends on `util.TextDecoder`, which lacks full ICU support + * @note Encoding support depends on `util.TextDecoder`, which lacks full ICU support * prior to Node.js 13. * * @see https://tools.ietf.org/html/rfc2047