build: Tweak jscs jsDoc rule 'checkAnnotations' and make pass
authorRicordisamoa <ricordisamoa@openmailbox.org>
Wed, 24 Feb 2016 02:47:10 +0000 (03:47 +0100)
committerRicordisamoa <ricordisamoa@openmailbox.org>
Wed, 24 Feb 2016 02:47:10 +0000 (03:47 +0100)
* Don't override "private", the default is to require empty
  values for the tag

* Move some @private tags after descriptions so the latter
  are not mistaken for tag values

* Require some value for @context, @source and @see tags

Change-Id: I583bb2ff3ec6537e1419732aaf1644ea8feb2255

.jscsrc
resources/src/mediawiki/api/upload.js

diff --git a/.jscsrc b/.jscsrc
index 3b94b90..116c5cf 100644 (file)
--- a/.jscsrc
+++ b/.jscsrc
                "checkAnnotations": {
                        "preset": "jsduck5",
                        "extra": {
-                               "context": true,
-                               "source": true,
-                               "see": true,
-                               "private": true
+                               "context": "some",
+                               "source": "some",
+                               "see": "some"
                        }
                },
                "checkParamNames": true,
index 437ddec..981a2e9 100644 (file)
@@ -17,9 +17,9 @@
                };
 
        /**
-        * @private
         * Get nonce for iframe IDs on the page.
         *
+        * @private
         * @return {number}
         */
        function getNonce() {
@@ -27,9 +27,9 @@
        }
 
        /**
-        * @private
         * Given a non-empty object, return one of its keys.
         *
+        * @private
         * @param {Object} obj
         * @return {string}
         */
@@ -42,9 +42,9 @@
        }
 
        /**
-        * @private
         * Get new iframe object for an upload.
         *
+        * @private
         * @return {HTMLIframeElement}
         */
        function getNewIframe( id ) {
@@ -55,9 +55,9 @@
        }
 
        /**
-        * @private
         * Shortcut for getting hidden inputs
         *
+        * @private
         * @return {jQuery}
         */
        function getHiddenInput( name, val ) {