Make SafeString show up correctly in docs

(cherry picked from commit 5378cfe)
emberjs · Feb 20, 2023 · b72b9a7 · b72b9a7
1 parent 8c2f360
commit b72b9a7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git 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
@@ -509,6 +509,7 @@ module.exports = {
     'toArray',
     'toggleProperty',
     'toString',
+    'toHTML',
     'tracked',
     'transitionTo',
     'transitionToRoute',