From b72b9a73fa935ba853f9c5ccbe248e0687cba582 Mon Sep 17 00:00:00 2001 From: Chris Krycho Date: Thu, 16 Feb 2023 10:33:06 -0700 Subject: [PATCH] Make `SafeString` show up correctly in docs (cherry picked from commit 5378cfea9e21a8f89e47488c38bf6b274be14a0c) --- packages/@ember/-internals/glimmer/lib/utils/string.ts | 9 +++++---- tests/docs/expected.js | 1 + 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/packages/@ember/-internals/glimmer/lib/utils/string.ts b/packages/@ember/-internals/glimmer/lib/utils/string.ts index 6f970d8d11b..63c35cffb28 100644 --- a/packages/@ember/-internals/glimmer/lib/utils/string.ts +++ b/packages/@ember/-internals/glimmer/lib/utils/string.ts @@ -32,9 +32,10 @@ import type { SafeString as GlimmerSafeString } from '@glimmer/runtime'; htmlSafe(someTrustedorSanitizedString); ``` - @public - @since 4.12.0 + @for @ember/template @class SafeString + @since 4.12.0 + @public */ export class SafeString implements GlimmerSafeString { private __string: string; @@ -48,7 +49,7 @@ export class SafeString implements GlimmerSafeString { @public @method toString - @returns The string marked as trusted + @returns {String} The string marked as trusted */ toString(): string { return `${this.__string}`; @@ -59,7 +60,7 @@ export class SafeString implements GlimmerSafeString { @public @method toHTML - @returns string + @returns {String} the trusted string, without any escaping applied */ toHTML(): string { return this.toString(); diff --git a/tests/docs/expected.js b/tests/docs/expected.js index 6c773636bf0..8049c62aa3a 100644 --- a/tests/docs/expected.js +++ b/tests/docs/expected.js @@ -509,6 +509,7 @@ module.exports = { 'toArray', 'toggleProperty', 'toString', + 'toHTML', 'tracked', 'transitionTo', 'transitionToRoute',