DevTools: [JSDoc] Fix injected scripts JSDoc and related code

Source/core/inspector/InjectedScriptSource.js

 /*
  * Copyright (C) 2007 Apple Inc.  All rights reserved.
  * Copyright (C) 2013 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1.  Redistributions of source code must retain the above copyright
  *     notice, this list of conditions and the following disclaimer.
@@ skipping 87 matching lines @@
 function toStringDescription(obj)
 {
     if (typeof obj === "number" && obj === 0 && 1 / obj < 0)
         return "-0"; // Negative zero.
     return "" + obj;
 }
 
 /**
  * Please use this bind, not the one from Function.prototype
  * @param {function(...)} func
  * @param {Object} thisObject

[aandrey, 2014/06/05 19:08:24]

why the check for nullability modificator does not work?
should be {?Object} or {!Object}, right?

[apavlov, 2014/06/05 19:26:25]

None of these fixed errors are currently checked for, too. I will add this check
with the following step (the nullability modifiers are checked for using Python
code, not Java).

  * @param {...} var_args
+ * @return {function(...)}
  */
 function bind(func, thisObject, var_args)
 {
     var args = slice(arguments, 2);
 
     /**
      * @param {...} var_args
      */
     function bound(var_args)
     {
@@ skipping 283 matching lines @@
             if ("symbol" in descriptor)
                 descriptor.symbol = this._wrapObject(descriptor.symbol, objectGroupName);
         }
         return descriptors;
     },
 
     /**
      * @param {string} objectId
      * @return {Array.<Object>|boolean}
      */
-    getInternalProperties: function(objectId, ownProperties)
+    getInternalProperties: function(objectId)
     {
         var parsedObjectId = this._parseObjectId(objectId);
         var object = this._objectForId(parsedObjectId);
         var objectGroupName = this._idToObjectGroupName[parsedObjectId.id];
         if (!this._isDefined(object))
             return false;
         var descriptors = [];
         var internalProperties = InjectedScriptHost.getInternalProperties(object);
         if (internalProperties) {
             for (var i = 0; i < internalProperties.length; i++) {
@@ skipping 140 matching lines @@
      * @return {*}
      */
     evaluate: function(expression, objectGroup, injectCommandLineAPI, returnByValue, generatePreview)
     {
         return this._evaluateAndWrap(InjectedScriptHost.evaluate, InjectedScriptHost, expression, objectGroup, false, injectCommandLineAPI, returnByValue, generatePreview);
     },
 
     /**
      * @param {string} objectId
      * @param {string} expression
+     * @param {string} args
      * @param {boolean} returnByValue
      * @return {!Object|string}
      */
     callFunctionOn: function(objectId, expression, args, returnByValue)
     {
         var parsedObjectId = this._parseObjectId(objectId);
         var object = this._objectForId(parsedObjectId);
         if (!this._isDefined(object))
             return "Could not find object with given id";
 
@@ skipping 48 matching lines @@
             if (callArgumentJson.type === "number" && typeof value !== "number")
                 value = Number(value);
             return value;
         }
         return undefined;
     },
 
     /**
      * @param {Function} evalFunction
      * @param {Object} object
+     * @param {string} expression
      * @param {string} objectGroup
      * @param {boolean} isEvalOnCallFrame
      * @param {boolean} injectCommandLineAPI
      * @param {boolean} returnByValue
      * @param {boolean} generatePreview
      * @param {!Array.<!Object>=} scopeChain
      * @return {!Object}
      */
     _evaluateAndWrap: function(evalFunction, object, expression, objectGroup, isEvalOnCallFrame, injectCommandLineAPI, returnByValue, generatePreview, scopeChain)
     {
@@ skipping 746 matching lines @@
  * @constructor
  */
 function CommandLineAPIImpl()
 {
 }
 
 CommandLineAPIImpl.prototype = {
     /**
      * @param {string} selector
      * @param {Node=} opt_startNode
+     * @return {*}
      */
     $: function (selector, opt_startNode)
     {
         if (this._canQuerySelectorOnNode(opt_startNode))
             return opt_startNode.querySelector(selector);
 
         return inspectedWindow.document.querySelector(selector);
     },
 
     /**
      * @param {string} selector
      * @param {Node=} opt_startNode
+     * @return {*}
      */
     $$: function (selector, opt_startNode)
     {
         if (this._canQuerySelectorOnNode(opt_startNode))
             return opt_startNode.querySelectorAll(selector);
         return inspectedWindow.document.querySelectorAll(selector);
     },
 
     /**
      * @param {Node=} node
      * @return {boolean}
      */
     _canQuerySelectorOnNode: function(node)
     {
         return !!node && InjectedScriptHost.type(node) === "node" && (node.nodeType === Node.ELEMENT_NODE || node.nodeType === Node.DOCUMENT_NODE || node.nodeType === Node.DOCUMENT_FRAGMENT_NODE);
     },
 
     /**
      * @param {string} xpath
      * @param {Node=} opt_startNode
+     * @return {*}
      */
     $x: function(xpath, opt_startNode)
     {
         var doc = (opt_startNode && opt_startNode.ownerDocument) || inspectedWindow.document;
         var result = doc.evaluate(xpath, opt_startNode || doc, null, XPathResult.ANY_TYPE, null);
         switch (result.resultType) {
         case XPathResult.NUMBER_TYPE:
             return result.numberValue;
         case XPathResult.STRING_TYPE:
             return result.stringValue;
         case XPathResult.BOOLEAN_TYPE:
             return result.booleanValue;
         default:
             var nodes = [];
             var node;
             while (node = result.iterateNext())
                 push(nodes, node);
             return nodes;
         }
     },
 
+    /**
+     * @return {*}
+     */
     dir: function(var_args)
     {
         return inspectedWindow.console.dir.apply(inspectedWindow.console, arguments)
     },
 
+    /**
+     * @return {*}
+     */
     dirxml: function(var_args)
     {
         return inspectedWindow.console.dirxml.apply(inspectedWindow.console, arguments)
     },
 
+    /**
+     * @return {!Array.<string>}
+     */
     keys: function(object)
     {
         return Object.keys(object);
     },
 
+    /**
+     * @return {!Array.<*>}
+     */
     values: function(object)
     {
         var result = [];
         for (var key in object)
             push(result, object[key]);
         return result;
     },
 
+    /**
+     * @return {*}
+     */
     profile: function(opt_title)
     {
         return inspectedWindow.console.profile.apply(inspectedWindow.console, arguments)
     },
 
+    /**
+     * @return {*}
+     */
     profileEnd: function(opt_title)
     {
         return inspectedWindow.console.profileEnd.apply(inspectedWindow.console, arguments)
     },
 
     /**
      * @param {Object} object
      * @param {Array.<string>|string=} opt_types
      */
     monitorEvents: function(object, opt_types)
@@ skipping 143 matching lines @@
      */
     _logEvent: function(event)
     {
         inspectedWindow.console.log(event.type, event);
     }
 }
 
 injectedScript._commandLineAPIImpl = new CommandLineAPIImpl();
 return injectedScript;
 })