cleanup: Use JSDoc for documentation comments

It's a better fit than gtk-doc, and eslint can validate that they are complete and use correct syntax. https://gitlab.gnome.org/GNOME/gnome-shell/merge_requests/805
2019-10-17 18:41:52 +02:00
parent 077d8f33fb
commit 61210fdae1
14 changed files with 291 additions and 245 deletions
--- a/js/ui/popupMenu.js
+++ b/js/ui/popupMenu.js
@ -27,7 +27,9 @@ function isPopupMenuItemVisible(child) {
 }

 /**
- * @side Side to which the arrow points.
+ * arrowIcon
+ * @param {St.Side} side - Side to which the arrow points.
+ * @returns {St.Icon} a new arrow icon
 */
 function arrowIcon(side) {
    let iconName;