Bug 1826366 - [remote] Apply lint --fix for valid-jsdoc in remote r=webdriver-reviewers,whimboo

Differential Revision: https://phabricator.services.mozilla.com/D174738

Author: juliandescottes

remote/cdp/CDPConnection.sys.mjs

@@ -70,11 +70,11 @@ export class CDPConnection extends WebSocketConnection {
   /**
    * Send an error back to the CDP client.
    *
-   * @param {Number} id
+   * @param {number} id
    *     Id of the packet which lead to an error.
    * @param {Error} err
    *     Error object with `message` and `stack` attributes.
-   * @param {String=} sessionId
+   * @param {string=} sessionId
    *     Id of the session used to send this packet. Falls back to the
    *     default session if not specified.
    */
@@ -90,12 +90,12 @@ export class CDPConnection extends WebSocketConnection {
   /**
    * Send an event coming from a Domain to the CDP client.
    *
-   * @param {String} method
+   * @param {string} method
    *     The event name. This is composed by a domain name, a dot character
    *     followed by the event name, e.g. `Target.targetCreated`.
-   * @param {Object} params
+   * @param {object} params
    *     A JSON-serializable object, which is the payload of this event.
-   * @param {String=} sessionId
+   * @param {string=} sessionId
    *     The sessionId from which this packet is emitted. Falls back to the
    *     default session if not specified.
    */
@@ -129,9 +129,9 @@ export class CDPConnection extends WebSocketConnection {
   /**
    * Interpret a given CDP packet for a given Session.
    *
-   * @param {String} sessionId
+   * @param {string} sessionId
    *     ID of the session for which we should execute a command.
-   * @param {String} message
+   * @param {string} message
    *     The stringified JSON payload of the CDP packet, which is about
    *     executing a Domain's function.
    */
@@ -158,11 +158,11 @@ export class CDPConnection extends WebSocketConnection {
   /**
    * Send the result of a call to a Domain's function back to the CDP client.
    *
-   * @param {Number} id
+   * @param {number} id
    *     The request id being sent by the client to call the domain's method.
-   * @param {Object} result
+   * @param {object} result
    *     A JSON-serializable object, which is the actual result.
-   * @param {String=} sessionId
+   * @param {string=} sessionId
    *     The sessionId from which this packet is emitted. Falls back to the
    *     default session if not specified.
    */
@@ -208,7 +208,7 @@ export class CDPConnection extends WebSocketConnection {
    * This packet is sent by a CDP client and is meant to execute
    * a particular function on a given Domain.
    *
-   * @param {Object} packet
+   * @param {object} packet
    *        JSON-serializable object sent by the client.
    */
   async onPacket(packet) {
@@ -269,10 +269,10 @@ export class CDPConnection extends WebSocketConnection {
 /**
  * Splits a CDP method into domain and command components.
  *
- * @param {String} method
+ * @param {string} method
  *     Name of the method to split, e.g. "Browser.getVersion".
  *
- * @returns {Object<String, String>}
+ * @returns {Object<string, string>}
  *     Object with the domain ("Browser") and command ("getVersion")
  *     as properties.
  */

remote/cdp/Error.sys.mjs

@@ -55,12 +55,12 @@ export class RemoteAgentError extends Error {
    * error serialisation to include discrete fields for each data
    * property.
    *
-   * @param {Object} json
+   * @param {object} json
    *     CDP error encoded as a JSON object, which must have a
    *     "message" field, where the first line will make out the error
    *     message and the subsequent lines the stacktrace.
    *
-   * @return {RemoteAgentError}
+   * @returns {RemoteAgentError}
    */
   static fromJSON(json) {
     const [message, ...stack] = json.message.split("\n");

remote/cdp/StreamRegistry.sys.mjs

@@ -86,7 +86,7 @@ export class StreamRegistry {
    * @param {string} path
    *      The path to the file to use as a stream.
    *
-   * @return {string}
+   * @returns {string}
    *     Stream handle (uuid)
    */
   add(stream) {
@@ -110,7 +110,7 @@ export class StreamRegistry {
    * @param {string} handle
    *      Handle of the stream to retrieve.
    *
-   * @return {Stream}
+   * @returns {Stream}
    *      The requested stream.
    */
   get(handle) {
@@ -129,7 +129,7 @@ export class StreamRegistry {
    * @param {string} handle
    *      Handle of the stream to remove.
    *
-   * @return {boolean}
+   * @returns {boolean}
    *     true if successfully removed
    */
   async remove(handle) {

remote/cdp/domains/Domain.sys.mjs

@@ -34,9 +34,9 @@ export class Domain {
    *
    * This can only be called from parent domains managed by a TabSession.
    *
-   * @param {String} method
+   * @param {string} method
    *        Name of the method to call on the child domain.
-   * @param {Object} params
+   * @param {object} params
    *        Optional parameters. Must be serializable.
    */
   executeInChild(method, params) {

remote/cdp/domains/content/DOM.sys.mjs

@@ -27,7 +27,7 @@ export class DOM extends ContentProcessDomain {
    *
    * Does not require domain to be enabled. Does not start tracking any objects.
    *
-   * @param {Object} options
+   * @param {object} options
    * @param {number=} options.backendNodeId [not supported]
    *     Identifier of the backend node.
    * @param {number=} options.depth [not supported]
@@ -41,7 +41,7 @@ export class DOM extends ContentProcessDomain {
    *     Whether or not iframes and shadow roots should be traversed
    *     when returning the subtree, defaults to false.
    *
-   * @return {DOM.Node}
+   * @returns {DOM.Node}
    *     Node description.
    */
   describeNode(options = {}) {
@@ -192,7 +192,7 @@ export class DOM extends ContentProcessDomain {
   /**
    * Resolves the JavaScript node object for a given NodeId or BackendNodeId.
    *
-   * @param {Object} options
+   * @param {object} options
    * @param {number} options.backendNodeId [required for now]
    *     Backend identifier of the node to resolve.
    * @param {number=} options.executionContextId
@@ -202,7 +202,7 @@ export class DOM extends ContentProcessDomain {
    * @param {string=} options.objectGroup [not supported]
    *     Symbolic group name that can be used to release multiple objects.
    *
-   * @return {Runtime.RemoteObject}
+   * @returns {Runtime.RemoteObject}
    *     JavaScript object wrapper for given node.
    */
   resolveNode(options = {}) {

remote/cdp/domains/content/Page.sys.mjs

@@ -163,10 +163,10 @@ export class Page extends ContentProcessDomain {
    * At this time, queued scripts do not get evaluated, hence `source` is marked as
    * "unsupported".
    *
-   * @param {Object} options
+   * @param {object} options
    * @param {string} options.source (not supported)
    * @param {string=} options.worldName
-   * @return {string} Page.ScriptIdentifier
+   * @returns {string} Page.ScriptIdentifier
    */
   addScriptToEvaluateOnNewDocument(options = {}) {
     const { source, worldName } = options;
@@ -187,15 +187,15 @@ export class Page extends ContentProcessDomain {
    *
    * Really it just creates an execution context with label "isolated".
    *
-   * @param {Object} options
+   * @param {object} options
    * @param {string} options.frameId
    *     Id of the frame in which the isolated world should be created.
    * @param {string=} options.worldName
    *     An optional name which is reported in the Execution Context.
    * @param {boolean=} options.grantUniversalAccess (not supported)
    *     This is a powerful option, use with caution.
    *
-   * @return {number} Runtime.ExecutionContextId
+   * @returns {number} Runtime.ExecutionContextId
    *     Execution context of the isolated world.
    */
   createIsolatedWorld(options = {}) {
@@ -234,7 +234,7 @@ export class Page extends ContentProcessDomain {
   /**
    * Controls whether page will emit lifecycle events.
    *
-   * @param {Object} options
+   * @param {object} options
    * @param {boolean} options.enabled
    *     If true, starts emitting lifecycle events.
    */
@@ -297,7 +297,7 @@ export class Page extends ContentProcessDomain {
   }
 
   /**
-   * @param {Object=} options
+   * @param {object=} options
    * @param {number} options.windowId
    *     The inner window id of the window the script has been loaded for.
    * @param {Window} options.window

remote/cdp/domains/content/Runtime.sys.mjs

@@ -153,10 +153,10 @@ export class Runtime extends ContentProcessDomain {
    *
    * Object group of the result is inherited from the target object.
    *
-   * @param {Object} options
+   * @param {object} options
    * @param {string} options.functionDeclaration
    *     Declaration of the function to call.
-   * @param {Array.<Object>=} options.arguments
+   * @param {Array.<object>=} options.arguments
    *     Call arguments. All call arguments must belong to the same
    *     JavaScript world as the target object.
    * @param {boolean=} options.awaitPromise
@@ -173,7 +173,7 @@ export class Runtime extends ContentProcessDomain {
    *     Whether the result is expected to be a JSON object
    *     which should be sent by value.
    *
-   * @return {Object.<RemoteObject, ExceptionDetails>}
+   * @returns {Object<RemoteObject, ExceptionDetails>}
    */
   callFunctionOn(options = {}) {
     if (typeof options.functionDeclaration != "string") {
@@ -237,7 +237,7 @@ export class Runtime extends ContentProcessDomain {
   /**
    * Evaluate expression on global object.
    *
-   * @param {Object} options
+   * @param {object} options
    * @param {string} options.expression
    *     Expression to evaluate.
    * @param {boolean=} options.awaitPromise
@@ -253,7 +253,7 @@ export class Runtime extends ContentProcessDomain {
    * @param {boolean=} options.userGesture [unsupported]
    *     Whether execution should be treated as initiated by user in the UI.
    *
-   * @return {Object<RemoteObject, exceptionDetails>}
+   * @returns {Object<RemoteObject, exceptionDetails>}
    *     The evaluation result, and optionally exception details.
    */
   evaluate(options = {}) {
@@ -473,7 +473,7 @@ export class Runtime extends ContentProcessDomain {
    *
    * @param {string} name
    *     Event name
-   * @param {Object=} options
+   * @param {object=} options
    * @param {number} options.windowId
    *     The inner window id of the newly instantiated document.
    * @param {Window} options.window
@@ -485,7 +485,7 @@ export class Runtime extends ContentProcessDomain {
    * @param {string=} options.contextType
    *     "default" or "isolated"
    *
-   * @return {number} ID of created context
+   * @returns {number} ID of created context
    *
    */
   _onContextCreated(name, options = {}) {
@@ -546,7 +546,7 @@ export class Runtime extends ContentProcessDomain {
    *
    * @param {string} name
    *     Event name
-   * @param {Object=} options
+   * @param {object=} options
    * @param {number} id
    *     The execution context id to destroy.
    * @param {number} windowId

remote/cdp/domains/content/runtime/ExecutionContext.sys.mjs

@@ -121,7 +121,7 @@ export class ExecutionContext {
   /**
    * Evaluate a Javascript expression.
    *
-   * @param {String} expression
+   * @param {string} expression
    *   The JS expression to evaluate against the JS context.
    * @param {boolean} options.awaitPromise
    *     Whether execution should `await` for resulting value
@@ -130,7 +130,7 @@ export class ExecutionContext {
    *     Whether the result is expected to be a JSON object
    *     that should be sent by value.
    *
-   * @return {Object} A multi-form object depending if the execution
+   * @returns {object} A multi-form object depending if the execution
    *   succeed or failed. If the expression failed to evaluate,
    *   it will return an object with an `exceptionDetails` attribute
    *   matching the `ExceptionDetails` CDP type. Otherwise it will
@@ -378,7 +378,7 @@ export class ExecutionContext {
    *
    * @param {Debugger.Object} debuggerObj
    *  The object to serialize
-   * @return {RemoteObject}
+   * @returns {RemoteObject}
    *  The serialized description of the given object
    */
   _toRemoteObject(debuggerObj) {
@@ -476,7 +476,7 @@ export class ExecutionContext {
    *
    * @param {Debugger.Object} debuggerObj
    *  The object to serialize
-   * @return {RemoteObject}
+   * @returns {RemoteObject}
    *  The serialized description of the given object
    */
   _toRemoteObjectByValue(debuggerObj) {
@@ -521,7 +521,7 @@ export class ExecutionContext {
    * @param {Debugger.Object} obj
    *  The object to convert
    *
-   * @return {Object}
+   * @returns {object}
    *  The converted object
    */
   _serialize(debuggerObj) {

remote/cdp/domains/parent/Emulation.sys.mjs

@@ -31,7 +31,7 @@ export class Emulation extends Domain {
    *   - window.innerHeight
    *   - "device-width"/"device-height"-related CSS media query results
    *
-   * @param {Object} options
+   * @param {object} options
    * @param {number} options.width
    *     Overriding width value in pixels. 0 disables the override.
    * @param {number} options.height
@@ -97,7 +97,7 @@ export class Emulation extends Domain {
   /**
    * Enables touch on platforms which do not support them.
    *
-   * @param {Object} options
+   * @param {object} options
    * @param {boolean} options.enabled
    *     Whether the touch event emulation should be enabled.
    * @param {number=} options.maxTouchPoints [not yet supported]
@@ -123,7 +123,7 @@ export class Emulation extends Domain {
   /**
    * Allows overriding user agent with the given string.
    *
-   * @param {Object} options
+   * @param {object} options
    * @param {string} options.userAgent
    *     User agent to use.
    * @param {string=} options.acceptLanguage [not yet supported]

remote/cdp/domains/parent/IO.sys.mjs

@@ -16,7 +16,7 @@ export class IO extends Domain {
   /**
    * Close the stream, discard any temporary backing storage.
    *
-   * @param {Object} options
+   * @param {object} options
    * @param {string} options.handle
    *     Handle of the stream to close.
    */
@@ -33,7 +33,7 @@ export class IO extends Domain {
   /**
    * Read a chunk of the stream.
    *
-   * @param {Object} options
+   * @param {object} options
    * @param {string} options.handle
    *     Handle of the stream to read.
    * @param {number=} options.offset
@@ -44,7 +44,7 @@ export class IO extends Domain {
    *     Maximum number of bytes to read (left upon the agent
    *     discretion if not specified).
    *
-   * @return {string, boolean, boolean}
+   * @returns {string, boolean, boolean}
    *     Data that were read, including flags for base64-encoded, and end-of-file reached.
    */
   async read(options = {}) {