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/misc/loginManager.js
+++ b/js/misc/loginManager.js
@ -74,8 +74,9 @@ function registerSessionWithGDM() {
 let _loginManager = null;

 /**
- * LoginManager:
+ * getLoginManager:
 * An abstraction over systemd/logind and ConsoleKit.
+ * @returns {object} - the LoginManager singleton
 *
 */
 function getLoginManager() {