js: Add JSDoc to exported functions and fix incorrect JSDoc formatting

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/1499>
2023-07-30 15:56:59 +03:00
parent 4642a8541d
commit 64aa871a8a
56 changed files with 623 additions and 280 deletions
--- a/js/ui/messageList.js
+++ b/js/ui/messageList.js
@ -17,6 +17,11 @@ var MESSAGE_ANIMATION_TIME = 100;

 var DEFAULT_EXPAND_LINES = 6;

+/**
+ * @param {string} text
+ * @param {boolean} allowMarkup
+ * @returns {string}
+ */
 function _fixMarkup(text, allowMarkup) {
    if (allowMarkup) {
        // Support &amp;, &quot;, &apos;, &lt; and &gt;, escape all other