From ebfa507d533f9ad2f23e4259a22a022a8f2b2613 Mon Sep 17 00:00:00 2001 From: Jack Franklin Date: Fri, 12 Jun 2020 11:21:29 +0100 Subject: [PATCH] docs: replace @return with @returns The former is not udnerstood by TSDoc --- examples/custom-event.js | 2 +- install.js | 2 +- new-docs/puppeteer.browser.waitfortarget.md | 4 +++- .../puppeteer.browserfetcher._getfolderpath.md | 4 +++- new-docs/puppeteer.browserfetcher.download.md | 4 +++- new-docs/puppeteer.connection.createsession.md | 4 +++- new-docs/puppeteer.connection.session.md | 4 +++- new-docs/puppeteer.elementhandle.boxmodel.md | 4 ++-- new-docs/puppeteer.elementhandle.md | 2 +- new-docs/puppeteer.httprequest.failure.md | 4 ++-- new-docs/puppeteer.httprequest.md | 2 +- src/Browser.ts | 2 +- src/BrowserFetcher.ts | 12 ++++++------ src/Connection.ts | 8 ++++---- src/DOMWorld.ts | 16 ++++++++-------- src/ExecutionContext.ts | 2 +- src/HTTPRequest.ts | 2 +- src/JSHandle.ts | 2 +- src/Launcher.ts | 2 +- src/LifecycleWatcher.ts | 2 +- test/golden-utils.js | 8 ++++---- test/requestinterception.spec.js | 2 +- test/utils.js | 8 ++++---- utils/check_availability.js | 10 +++++----- utils/doclint/Message.js | 4 ++-- utils/doclint/Source.js | 16 ++++++++-------- utils/doclint/check_public_api/Documentation.js | 6 +++--- utils/doclint/check_public_api/JSBuilder.js | 8 ++++---- utils/doclint/check_public_api/MDBuilder.js | 8 ++++---- utils/doclint/check_public_api/index.js | 12 ++++++------ utils/doclint/preprocessor/index.js | 2 +- utils/fetch_devices.js | 12 ++++++------ utils/testserver/index.js | 6 +++--- 33 files changed, 98 insertions(+), 88 deletions(-) diff --git a/examples/custom-event.js b/examples/custom-event.js index 44f3f9693637e..bf196345baf54 100644 --- a/examples/custom-event.js +++ b/examples/custom-event.js @@ -30,7 +30,7 @@ const puppeteer = require('puppeteer'); /** * Attach an event listener to page to capture a custom event on page load/navigation. * @param {string} type Event name. - * @return {!Promise} + * @returns {!Promise} */ function listenFor(type) { return page.evaluateOnNewDocument((type) => { diff --git a/install.js b/install.js index e33485cd0e7c5..13272b60ba297 100644 --- a/install.js +++ b/install.js @@ -97,7 +97,7 @@ async function download() { /** * @param {!Array} - * @return {!Promise} + * @returns {!Promise} */ function onSuccess(localRevisions) { if (os.arch() !== 'arm64') { diff --git a/new-docs/puppeteer.browser.waitfortarget.md b/new-docs/puppeteer.browser.waitfortarget.md index 8469689b74393..0cea9e3dec478 100644 --- a/new-docs/puppeteer.browser.waitfortarget.md +++ b/new-docs/puppeteer.browser.waitfortarget.md @@ -17,9 +17,11 @@ waitForTarget(predicate: (x: Target) => boolean, options?: { | Parameter | Type | Description | | --- | --- | --- | | predicate | (x: [Target](./puppeteer.target.md)) => boolean | | -| options | { timeout?: number; } | {!Promise<!Target>} | +| options | { timeout?: number; } | | Returns: Promise<[Target](./puppeteer.target.md)> +{!Promise<!Target>} + diff --git a/new-docs/puppeteer.browserfetcher._getfolderpath.md b/new-docs/puppeteer.browserfetcher._getfolderpath.md index 202f189fc8de7..7c3e0203687d1 100644 --- a/new-docs/puppeteer.browserfetcher._getfolderpath.md +++ b/new-docs/puppeteer.browserfetcher._getfolderpath.md @@ -14,9 +14,11 @@ _getFolderPath(revision: string): string; | Parameter | Type | Description | | --- | --- | --- | -| revision | string | {string} | +| revision | string | | Returns: string +{string} + diff --git a/new-docs/puppeteer.browserfetcher.download.md b/new-docs/puppeteer.browserfetcher.download.md index 71106ac303fd4..a04a3e33680b1 100644 --- a/new-docs/puppeteer.browserfetcher.download.md +++ b/new-docs/puppeteer.browserfetcher.download.md @@ -15,9 +15,11 @@ download(revision: string, progressCallback: (x: number, y: number) => void): Pr | Parameter | Type | Description | | --- | --- | --- | | revision | string | | -| progressCallback | (x: number, y: number) => void | {!Promise<!BrowserFetcher.RevisionInfo>} | +| progressCallback | (x: number, y: number) => void | | Returns: Promise<BrowserFetcherRevisionInfo> +{!Promise<!BrowserFetcher.RevisionInfo>} + diff --git a/new-docs/puppeteer.connection.createsession.md b/new-docs/puppeteer.connection.createsession.md index 08af6bb174ea8..7cf05505a2d49 100644 --- a/new-docs/puppeteer.connection.createsession.md +++ b/new-docs/puppeteer.connection.createsession.md @@ -14,9 +14,11 @@ createSession(targetInfo: Protocol.Target.TargetInfo): Promise; | Parameter | Type | Description | | --- | --- | --- | -| targetInfo | Protocol.Target.TargetInfo | {!Promise<!CDPSession>} | +| targetInfo | Protocol.Target.TargetInfo | | Returns: Promise<[CDPSession](./puppeteer.cdpsession.md)> +{!Promise<!CDPSession>} + diff --git a/new-docs/puppeteer.connection.session.md b/new-docs/puppeteer.connection.session.md index 8e18b7e313481..6ccf1a47bd2d8 100644 --- a/new-docs/puppeteer.connection.session.md +++ b/new-docs/puppeteer.connection.session.md @@ -14,9 +14,11 @@ session(sessionId: string): CDPSession | null; | Parameter | Type | Description | | --- | --- | --- | -| sessionId | string | {?CDPSession} | +| sessionId | string | | Returns: [CDPSession](./puppeteer.cdpsession.md) \| null +{?CDPSession} + diff --git a/new-docs/puppeteer.elementhandle.boxmodel.md b/new-docs/puppeteer.elementhandle.boxmodel.md index 7fdd487a823e6..2f54e48c1381c 100644 --- a/new-docs/puppeteer.elementhandle.boxmodel.md +++ b/new-docs/puppeteer.elementhandle.boxmodel.md @@ -4,8 +4,6 @@ ## ElementHandle.boxModel() method - {!Promise<?BoxModel>} - Signature: ```typescript @@ -15,3 +13,5 @@ boxModel(): Promise; Promise<BoxModel \| null> +{!Promise<?BoxModel>} + diff --git a/new-docs/puppeteer.elementhandle.md b/new-docs/puppeteer.elementhandle.md index 3dd27169799e7..6280f20a45367 100644 --- a/new-docs/puppeteer.elementhandle.md +++ b/new-docs/puppeteer.elementhandle.md @@ -39,7 +39,7 @@ export declare class ElementHandle extends JSHandle | [$x(expression)](./puppeteer.elementhandle._x.md) | | | | [asElement()](./puppeteer.elementhandle.aselement.md) | | | | [boundingBox()](./puppeteer.elementhandle.boundingbox.md) | | | -| [boxModel()](./puppeteer.elementhandle.boxmodel.md) | | {!Promise<?BoxModel>} | +| [boxModel()](./puppeteer.elementhandle.boxmodel.md) | | | | [click(options)](./puppeteer.elementhandle.click.md) | | | | [contentFrame()](./puppeteer.elementhandle.contentframe.md) | | | | [focus()](./puppeteer.elementhandle.focus.md) | | | diff --git a/new-docs/puppeteer.httprequest.failure.md b/new-docs/puppeteer.httprequest.failure.md index a9e8626948118..3cbf6433c2a9d 100644 --- a/new-docs/puppeteer.httprequest.failure.md +++ b/new-docs/puppeteer.httprequest.failure.md @@ -4,8 +4,6 @@ ## HTTPRequest.failure() method - {?{errorText: string}} - Signature: ```typescript @@ -17,3 +15,5 @@ failure(): { { errorText: string; } \| null +{?{errorText: string}} + diff --git a/new-docs/puppeteer.httprequest.md b/new-docs/puppeteer.httprequest.md index f086f6d45b82e..9a2df0580d4f7 100644 --- a/new-docs/puppeteer.httprequest.md +++ b/new-docs/puppeteer.httprequest.md @@ -33,7 +33,7 @@ export declare class HTTPRequest | --- | --- | --- | | [abort(errorCode)](./puppeteer.httprequest.abort.md) | | | | [continue(overrides)](./puppeteer.httprequest.continue.md) | | | -| [failure()](./puppeteer.httprequest.failure.md) | | {?{errorText: string}} | +| [failure()](./puppeteer.httprequest.failure.md) | | | | [frame()](./puppeteer.httprequest.frame.md) | | | | [headers()](./puppeteer.httprequest.headers.md) | | | | [isNavigationRequest()](./puppeteer.httprequest.isnavigationrequest.md) | | | diff --git a/src/Browser.ts b/src/Browser.ts index 2dcf35727d000..9b096b0e6ceea 100644 --- a/src/Browser.ts +++ b/src/Browser.ts @@ -224,7 +224,7 @@ export class Browser extends EventEmitter { /** * @param {function(!Target):boolean} predicate * @param {{timeout?: number}=} options - * @return {!Promise} + * @returns {!Promise} */ async waitForTarget( predicate: (x: Target) => boolean, diff --git a/src/BrowserFetcher.ts b/src/BrowserFetcher.ts index 9c63c968a5827..608dc0bf22f7d 100644 --- a/src/BrowserFetcher.ts +++ b/src/BrowserFetcher.ts @@ -84,7 +84,7 @@ function archiveName( * @param {string} platform * @param {string} host * @param {string} revision - * @return {string} + * @returns {string} */ function downloadURL( product: Product, @@ -211,7 +211,7 @@ export class BrowserFetcher { /** * @param {string} revision * @param {?function(number, number):void} progressCallback - * @return {!Promise} + * @returns {!Promise} */ async download( revision: string, @@ -332,7 +332,7 @@ export class BrowserFetcher { /** * @param {string} revision - * @return {string} + * @returns {string} */ _getFolderPath(revision: string): string { return path.join(this._downloadsFolder, this._platform + '-' + revision); @@ -355,7 +355,7 @@ function parseFolderPath( * @param {string} url * @param {string} destinationPath * @param {?function(number, number):void} progressCallback - * @return {!Promise} + * @returns {!Promise} */ function downloadFile( url: string, @@ -417,7 +417,7 @@ function install(archivePath: string, folderPath: string): Promise { /** * @param {string} tarPath * @param {string} folderPath - * @return {!Promise} + * @returns {!Promise} */ function extractTar(tarPath: string, folderPath: string): Promise { // eslint-disable-next-line @typescript-eslint/no-var-requires @@ -441,7 +441,7 @@ function extractTar(tarPath: string, folderPath: string): Promise { * * @param {string} dmgPath * @param {string} folderPath - * @return {!Promise} + * @returns {!Promise} */ function installDMG(dmgPath: string, folderPath: string): Promise { let mountPath; diff --git a/src/Connection.ts b/src/Connection.ts index 0e95582a0be1e..70f42cf537878 100644 --- a/src/Connection.ts +++ b/src/Connection.ts @@ -55,7 +55,7 @@ export class Connection extends EventEmitter { /** * @param {string} sessionId - * @return {?CDPSession} + * @returns {?CDPSession} */ session(sessionId: string): CDPSession | null { return this._sessions.get(sessionId) || null; @@ -146,7 +146,7 @@ export class Connection extends EventEmitter { /** * @param {Protocol.Target.TargetInfo} targetInfo - * @return {!Promise} + * @returns {!Promise} */ async createSession( targetInfo: Protocol.Target.TargetInfo @@ -248,7 +248,7 @@ export class CDPSession extends EventEmitter { * @param {!Error} error * @param {string} method * @param {{error: {message: string, data: any}}} object - * @return {!Error} + * @returns {!Error} */ function createProtocolError( error: Error, @@ -263,7 +263,7 @@ function createProtocolError( /** * @param {!Error} error * @param {string} message - * @return {!Error} + * @returns {!Error} */ function rewriteError(error: Error, message: string): Error { error.message = message; diff --git a/src/DOMWorld.ts b/src/DOMWorld.ts index 886b2b4907a9e..cc30a458b0825 100644 --- a/src/DOMWorld.ts +++ b/src/DOMWorld.ts @@ -93,7 +93,7 @@ export class DOMWorld { } /** - * @return {!Promise} + * @returns {!Promise} */ executionContext(): Promise { if (this._detached) @@ -106,7 +106,7 @@ export class DOMWorld { /** * @param {Function|string} pageFunction * @param {!Array<*>} args - * @return {!Promise} + * @returns {!Promise} */ async evaluateHandle( pageFunction: Function | string, @@ -119,7 +119,7 @@ export class DOMWorld { /** * @param {Function|string} pageFunction * @param {!Array<*>} args - * @return {!Promise<*>} + * @returns {!Promise<*>} */ async evaluate( pageFunction: Function | string, @@ -131,7 +131,7 @@ export class DOMWorld { /** * @param {string} selector - * @return {!Promise} + * @returns {!Promise} */ async $(selector: string): Promise { const document = await this._document(); @@ -179,7 +179,7 @@ export class DOMWorld { /** * @param {string} selector - * @return {!Promise>} + * @returns {!Promise>} */ async $$(selector: string): Promise { const document = await this._document(); @@ -232,7 +232,7 @@ export class DOMWorld { /** * @param {!{url?: string, path?: string, content?: string, type?: string}} options - * @return {!Promise} + * @returns {!Promise} */ async addScriptTag(options: { url?: string; @@ -497,7 +497,7 @@ export class DOMWorld { * @param {boolean} isXPath * @param {boolean} waitForVisible * @param {boolean} waitForHidden - * @return {?Node|boolean} + * @returns {?Node|boolean} */ function predicate( selectorOrXPath: string, @@ -690,7 +690,7 @@ async function waitForPredicatePageFunction( if (typeof polling === 'number') return await pollInterval(polling); /** - * @return {!Promise<*>} + * @returns {!Promise<*>} */ async function pollMutation(): Promise { const success = await predicate(...args); diff --git a/src/ExecutionContext.ts b/src/ExecutionContext.ts index 4097549606472..c82ad8443d785 100644 --- a/src/ExecutionContext.ts +++ b/src/ExecutionContext.ts @@ -149,7 +149,7 @@ export class ExecutionContext { /** * @param {*} arg - * @return {*} + * @returns {*} * @this {ExecutionContext} */ function convertArgument(this: ExecutionContext, arg: unknown): unknown { diff --git a/src/HTTPRequest.ts b/src/HTTPRequest.ts index eeaaef7a15c10..b8ed5057800bf 100644 --- a/src/HTTPRequest.ts +++ b/src/HTTPRequest.ts @@ -102,7 +102,7 @@ export class HTTPRequest { } /** - * @return {?{errorText: string}} + * @returns {?{errorText: string}} */ failure(): { errorText: string } | null { if (!this._failureText) return null; diff --git a/src/JSHandle.ts b/src/JSHandle.ts index 867707a32c92a..d8be11c637fca 100644 --- a/src/JSHandle.ts +++ b/src/JSHandle.ts @@ -437,7 +437,7 @@ export class ElementHandle extends JSHandle { } /** - * @return {!Promise} + * @returns {!Promise} */ async boxModel(): Promise { const result = await this._getBoxModel(); diff --git a/src/Launcher.ts b/src/Launcher.ts index 7499ca3e2d045..0a0e9f7cf14f4 100644 --- a/src/Launcher.ts +++ b/src/Launcher.ts @@ -154,7 +154,7 @@ class ChromeLauncher implements ProductLauncher { /** * @param {!Launcher.ChromeArgOptions=} options - * @return {!Array} + * @returns {!Array} */ defaultArgs(options: ChromeArgOptions = {}): string[] { const chromeArguments = [ diff --git a/src/LifecycleWatcher.ts b/src/LifecycleWatcher.ts index 2e2f3fb3f7373..775453374c752 100644 --- a/src/LifecycleWatcher.ts +++ b/src/LifecycleWatcher.ts @@ -212,7 +212,7 @@ export class LifecycleWatcher { /** * @param {!Frame} frame * @param {!Array} expectedLifecycle - * @return {boolean} + * @returns {boolean} */ function checkLifecycle( frame: Frame, diff --git a/test/golden-utils.js b/test/golden-utils.js index 11a5be71a304b..c8ac32b849ec6 100644 --- a/test/golden-utils.js +++ b/test/golden-utils.js @@ -33,7 +33,7 @@ const GoldenComparators = { * @param {?Object} actualBuffer * @param {!Buffer} expectedBuffer * @param {!string} mimeType - * @return {?{diff: (!Object:undefined), errorMessage: (string|undefined)}} + * @returns {?{diff: (!Object:undefined), errorMessage: (string|undefined)}} */ function compareImages(actualBuffer, expectedBuffer, mimeType) { if (!actualBuffer || !(actualBuffer instanceof Buffer)) @@ -67,7 +67,7 @@ function compareImages(actualBuffer, expectedBuffer, mimeType) { /** * @param {?Object} actual * @param {!Buffer} expectedBuffer - * @return {?{diff: (!Object:undefined), errorMessage: (string|undefined)}} + * @returns {?{diff: (!Object:undefined), errorMessage: (string|undefined)}} */ function compareText(actual, expectedBuffer) { if (typeof actual !== 'string') @@ -89,7 +89,7 @@ function compareText(actual, expectedBuffer) { /** * @param {?Object} actual * @param {string} goldenName - * @return {!{pass: boolean, message: (undefined|string)}} + * @returns {!{pass: boolean, message: (undefined|string)}} */ function compare(goldenPath, outputPath, actual, goldenName) { goldenPath = path.normalize(goldenPath); @@ -149,7 +149,7 @@ function compare(goldenPath, outputPath, actual, goldenName) { * @param {string} filePath * @param {string} suffix * @param {string=} customExtension - * @return {string} + * @returns {string} */ function addSuffix(filePath, suffix, customExtension) { const dirname = path.dirname(filePath); diff --git a/test/requestinterception.spec.js b/test/requestinterception.spec.js index 1a8265d83a49e..8c65771dc804a 100644 --- a/test/requestinterception.spec.js +++ b/test/requestinterception.spec.js @@ -693,7 +693,7 @@ describe('request interception', function () { /** * @param {string} path - * @return {string} + * @returns {string} */ function pathToFileURL(path) { let pathName = path.replace(/\\/g, '/'); diff --git a/test/utils.js b/test/utils.js index 1644bc5dcb670..0b3f2bfd25da3 100644 --- a/test/utils.js +++ b/test/utils.js @@ -42,7 +42,7 @@ const utils = (module.exports = { }, /** - * @return {string} + * @returns {string} */ projectRoot: function () { return PROJECT_ROOT; @@ -52,7 +52,7 @@ const utils = (module.exports = { * @param {!Page} page * @param {string} frameId * @param {string} url - * @return {!Frame} + * @returns {!Frame} */ attachFrame: async function (page, frameId, url) { const handle = await page.evaluateHandle(attachFrame, frameId, url); @@ -103,7 +103,7 @@ const utils = (module.exports = { /** * @param {!Frame} frame * @param {string=} indentation - * @return {Array} + * @returns {Array} */ dumpFrames: function (frame, indentation) { indentation = indentation || ''; @@ -118,7 +118,7 @@ const utils = (module.exports = { /** * @param {!EventEmitter} emitter * @param {string} eventName - * @return {!Promise} + * @returns {!Promise} */ waitEvent: function (emitter, eventName, predicate = () => true) { return new Promise((fulfill) => { diff --git a/utils/check_availability.js b/utils/check_availability.js index 3a2c289b624d5..8cafc14025f3a 100755 --- a/utils/check_availability.js +++ b/utils/check_availability.js @@ -203,7 +203,7 @@ async function checkRangeAvailability({ * @param {!Table} table * @param {string} name * @param {number} revision - * @return {boolean} + * @returns {boolean} */ async function checkAndDrawRevisionAvailability(table, name, revision) { const promises = fetchers.map((fetcher) => fetcher.canDownload(revision)); @@ -225,7 +225,7 @@ async function checkAndDrawRevisionAvailability(table, name, revision) { /** * @param {string} url - * @return {!Promise} + * @returns {!Promise} */ function fetch(url) { let resolve; @@ -253,7 +253,7 @@ function fetch(url) { /** * @param {number} size - * @return {string} + * @returns {string} */ function spaceString(size) { return new Array(size).fill(' ').join(''); @@ -261,7 +261,7 @@ function spaceString(size) { /** * @param {string} text - * @return {string} + * @returns {string} */ function filterOutColors(text) { for (const colorName in colors) { @@ -274,7 +274,7 @@ function filterOutColors(text) { /** * @param {string} text * @param {number} length - * @return {string} + * @returns {string} */ function padCenter(text, length) { const printableCharacters = filterOutColors(text); diff --git a/utils/doclint/Message.js b/utils/doclint/Message.js index cb7d15aeca835..374b60d44d067 100644 --- a/utils/doclint/Message.js +++ b/utils/doclint/Message.js @@ -26,7 +26,7 @@ class Message { /** * @param {string} text - * @return {!Message} + * @returns {!Message} */ static error(text) { return new Message('error', text); @@ -34,7 +34,7 @@ class Message { /** * @param {string} text - * @return {!Message} + * @returns {!Message} */ static warning(text) { return new Message('warning', text); diff --git a/utils/doclint/Source.js b/utils/doclint/Source.js index 60a3d77b0a652..0f7c13234f75c 100644 --- a/utils/doclint/Source.js +++ b/utils/doclint/Source.js @@ -38,21 +38,21 @@ class Source { } /** - * @return {string} + * @returns {string} */ filePath() { return this._filePath; } /** - * @return {string} + * @returns {string} */ projectPath() { return this._projectPath; } /** - * @return {string} + * @returns {string} */ name() { return this._name; @@ -60,7 +60,7 @@ class Source { /** * @param {string} text - * @return {boolean} + * @returns {boolean} */ setText(text) { if (text === this._text) return false; @@ -70,14 +70,14 @@ class Source { } /** - * @return {string} + * @returns {string} */ text() { return this._text; } /** - * @return {boolean} + * @returns {boolean} */ hasUpdatedText() { return this._hasUpdatedText; @@ -89,7 +89,7 @@ class Source { /** * @param {string} filePath - * @return {!Promise} + * @returns {!Promise} */ static async readFile(filePath) { filePath = path.resolve(filePath); @@ -100,7 +100,7 @@ class Source { /** * @param {string} dirPath * @param {string=} extension - * @return {!Promise>} + * @returns {!Promise>} */ static async readdir(dirPath, extension = '') { const fileNames = await readdirAsync(dirPath); diff --git a/utils/doclint/check_public_api/Documentation.js b/utils/doclint/check_public_api/Documentation.js index 44e0908fa1afa..9bbaabfc70319 100644 --- a/utils/doclint/check_public_api/Documentation.js +++ b/utils/doclint/check_public_api/Documentation.js @@ -100,7 +100,7 @@ Documentation.Member = class { * @param {string} name * @param {!Array} argsArray * @param {?Documentation.Type} returnType - * @return {!Documentation.Member} + * @returns {!Documentation.Member} */ static createMethod(name, argsArray, returnType, returnComment, comment) { return new Documentation.Member( @@ -118,7 +118,7 @@ Documentation.Member = class { * @param {!Documentation.Type} type * @param {string=} comment * @param {boolean=} required - * @return {!Documentation.Member} + * @returns {!Documentation.Member} */ static createProperty(name, type, comment, required) { return new Documentation.Member( @@ -136,7 +136,7 @@ Documentation.Member = class { * @param {string} name * @param {?Documentation.Type=} type * @param {string=} comment - * @return {!Documentation.Member} + * @returns {!Documentation.Member} */ static createEvent(name, type = null, comment) { return new Documentation.Member('event', name, type, [], comment); diff --git a/utils/doclint/check_public_api/JSBuilder.js b/utils/doclint/check_public_api/JSBuilder.js index 1b7f31d71257a..a1744125b903f 100644 --- a/utils/doclint/check_public_api/JSBuilder.js +++ b/utils/doclint/check_public_api/JSBuilder.js @@ -68,7 +68,7 @@ function checkSources(sources) { /** * @param {!Array} classes * @param {!Map} inheritance - * @return {!Array} + * @returns {!Array} */ function recreateClassesWithInheritance(classes, inheritance) { const classesByName = new Map(classes.map((cls) => [cls.name, cls])); @@ -155,7 +155,7 @@ function checkSources(sources) { /** * @param {!ts.Type} type - * @return {!Documentation.Type} + * @returns {!Documentation.Type} */ function serializeType(type, circular = []) { let typeName = checker.typeToString(type); @@ -207,7 +207,7 @@ function checkSources(sources) { /** * @param {!ts.Symbol} symbol - * @return {boolean} + * @returns {boolean} */ function symbolHasPrivateModifier(symbol) { const modifiers = @@ -220,7 +220,7 @@ function checkSources(sources) { /** * @param {string} className * @param {!ts.Symbol} symbol - * @return {} + * @returns {} */ function serializeClass(className, symbol, node) { /** @type {!Array} */ diff --git a/utils/doclint/check_public_api/MDBuilder.js b/utils/doclint/check_public_api/MDBuilder.js index a51b541e2a996..46a4e6cfce5d3 100644 --- a/utils/doclint/check_public_api/MDBuilder.js +++ b/utils/doclint/check_public_api/MDBuilder.js @@ -21,7 +21,7 @@ class MDOutline { /** * @param {!Page} page * @param {string} text - * @return {!MDOutline} + * @returns {!MDOutline} */ static async create(page, text) { // Render markdown as HTML. @@ -86,7 +86,7 @@ class MDOutline { /** * @param {string} str - * @return {string} + * @returns {string} */ function findType(str) { const start = str.indexOf('<') + 1; @@ -227,7 +227,7 @@ class MDOutline { /** * @param {!Node} fromInclusive * @param {!Node} toExclusive - * @return {!DocumentFragment} + * @returns {!DocumentFragment} */ function extractSiblingsIntoFragment(fromInclusive, toExclusive) { const fragment = document.createDocumentFragment(); @@ -387,7 +387,7 @@ class MDOutline { /** * @param {!Page} page * @param {!Array} sources - * @return {!Promise<{documentation: !Documentation, errors: !Array}>} + * @returns {!Promise<{documentation: !Documentation, errors: !Array}>} */ module.exports = async function (page, sources) { const classes = []; diff --git a/utils/doclint/check_public_api/index.js b/utils/doclint/check_public_api/index.js index 2c5ff56ee250c..5b27ba7205c57 100644 --- a/utils/doclint/check_public_api/index.js +++ b/utils/doclint/check_public_api/index.js @@ -30,7 +30,7 @@ const EXCLUDE_PROPERTIES = new Set([ /** * @param {!Page} page * @param {!Array} mdSources - * @return {!Promise>} + * @returns {!Promise>} */ module.exports = async function lint(page, mdSources, jsSources) { const mdResult = await mdBuilder(page, mdSources); @@ -57,7 +57,7 @@ module.exports = async function lint(page, mdSources, jsSources) { /** * @param {!Documentation} doc - * @return {!Array} + * @returns {!Array} */ function checkSorting(doc) { const errors = []; @@ -122,7 +122,7 @@ function checkSorting(doc) { /** * @param {!Array} jsSources * @param {!Documentation} jsDocumentation - * @return {!Documentation} + * @returns {!Documentation} */ function filterJSDocumentation(jsSources, jsDocumentation) { const apijs = jsSources.find((source) => source.name() === 'api.js'); @@ -142,7 +142,7 @@ function filterJSDocumentation(jsSources, jsDocumentation) { /** * @param {!Documentation} doc - * @return {!Array} + * @returns {!Array} */ function checkDuplicates(doc) { const errors = []; @@ -183,7 +183,7 @@ const expectedNonExistingMethods = new Map([ /** * @param {!Documentation} actual * @param {!Documentation} expected - * @return {!Array} + * @returns {!Array} */ function compareDocumentations(actual, expected) { const errors = []; @@ -684,7 +684,7 @@ function compareDocumentations(actual, expected) { /** * @param {!Array} actual * @param {!Array} expected - * @return {{extra: !Array, missing: !Array, equal: !Array}} + * @returns {{extra: !Array, missing: !Array, equal: !Array}} */ function diff(actual, expected) { const N = actual.length; diff --git a/utils/doclint/preprocessor/index.js b/utils/doclint/preprocessor/index.js index ba631e4b4aa9c..2dac976a94793 100644 --- a/utils/doclint/preprocessor/index.js +++ b/utils/doclint/preprocessor/index.js @@ -89,7 +89,7 @@ module.exports.runCommands = function (sources, version) { /** * @param {{name: string, from: number, to: number, source: !Source}} command * @param {string} editText - * @return {boolean} + * @returns {boolean} */ function applyCommand(command, editText) { const text = command.source.text(); diff --git a/utils/fetch_devices.js b/utils/fetch_devices.js index 26aaa8093f385..547b68842e177 100755 --- a/utils/fetch_devices.js +++ b/utils/fetch_devices.js @@ -123,7 +123,7 @@ async function main(url) { * @param {string} deviceName * @param {*} descriptor * @param {boolean} landscape - * @return {!Object} + * @returns {!Object} */ function createDevice(chromeVersion, deviceName, descriptor, landscape) { const devicePayload = loadFromJSONV1(descriptor); @@ -148,7 +148,7 @@ function createDevice(chromeVersion, deviceName, descriptor, landscape) { /** * @param {*} json - * @return {?Object} + * @returns {?Object} */ function loadFromJSONV1(json) { /** @@ -156,7 +156,7 @@ function loadFromJSONV1(json) { * @param {string} key * @param {string} type * @param {*=} defaultValue - * @return {*} + * @returns {*} */ function parseValue(object, key, type, defaultValue) { if ( @@ -184,7 +184,7 @@ function loadFromJSONV1(json) { /** * @param {*} object * @param {string} key - * @return {number} + * @returns {number} */ function parseIntValue(object, key) { const value = /** @type {number} */ (parseValue(object, key, 'number')); @@ -195,7 +195,7 @@ function loadFromJSONV1(json) { /** * @param {*} json - * @return {!{width: number, height: number}} + * @returns {!{width: number, height: number}} */ function parseOrientation(json) { const result = {}; @@ -259,7 +259,7 @@ function loadFromJSONV1(json) { /** * @param {url} - * @return {!Promise} + * @returns {!Promise} */ function httpGET(url) { let fulfill, reject; diff --git a/utils/testserver/index.js b/utils/testserver/index.js index fcdbb9ef93b0d..a65910217d791 100644 --- a/utils/testserver/index.js +++ b/utils/testserver/index.js @@ -29,7 +29,7 @@ class TestServer { /** * @param {string} dirPath * @param {number} port - * @return {!TestServer} + * @returns {!TestServer} */ static async create(dirPath, port) { const server = new TestServer(dirPath, port); @@ -40,7 +40,7 @@ class TestServer { /** * @param {string} dirPath * @param {number} port - * @return {!TestServer} + * @returns {!TestServer} */ static async createHTTPS(dirPath, port) { const server = new TestServer(dirPath, port, { @@ -151,7 +151,7 @@ class TestServer { /** * @param {string} path - * @return {!Promise} + * @returns {!Promise} */ waitForRequest(path) { let promise = this._requestSubscribers.get(path);