Skip to content

Commit 7d701aa

Browse files
committed
Fix jsdoc of strings.encode
1 parent 3ec5ab4 commit 7d701aa

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

eclipse-scout-core/src/util/strings.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2010, 2025 BSI Business Systems Integration AG
2+
* Copyright (c) 2010, 2026 BSI Business Systems Integration AG
33
*
44
* This program and the accompanying materials are made
55
* available under the terms of the Eclipse Public License 2.0
@@ -128,9 +128,11 @@ export const strings = {
128128
},
129129

130130
/**
131-
* Returns the HTML encoded text. Example: 'Foo<br>Bar' returns 'Foo&amp;lt;br&amp;gt;Bar'.
132-
* If the argument is or undefined, the same value is returned.
133-
* @param text plain text to encode
131+
* Returns the HTML encoded text. If the text is falsy, the input value is returned.
132+
*
133+
* Example: 'Foo&lt;br&gt;Bar' returns 'Foo&amp;lt;br&amp;gt;Bar'.
134+
*
135+
* @param text text to encode
134136
* @returns HTML encoded text
135137
*/
136138
encode(text: string): string {

0 commit comments

Comments
 (0)