From 9f722e93ea97b8e6d706bd450fb6fd8c7e109f89 Mon Sep 17 00:00:00 2001 From: TASNEEM KOUSHAR Date: Mon, 12 Jul 2021 15:12:44 +0530 Subject: [PATCH] chore(docs): fix tsdoc warnings * fix: added script * fix: updated script * fix: updated script * fix: added comment * fix: added comments * fix: connection method to public * fix: removed incorrect tags * fix: some of the warnings --- src/common/Input.ts | 5 ----- src/common/Page.ts | 48 +++++++++++++++++++++------------------------ 2 files changed, 22 insertions(+), 31 deletions(-) diff --git a/src/common/Input.ts b/src/common/Input.ts index 293c9ab461826..620e387780f41 100644 --- a/src/common/Input.ts +++ b/src/common/Input.ts @@ -492,7 +492,6 @@ export class Mouse { * Dispatches a `drag` event. * @param start - starting point for drag * @param target - point to drag to - * ``` */ async drag(start: Point, target: Point): Promise { const promise = new Promise((resolve) => { @@ -509,7 +508,6 @@ export class Mouse { /** * Dispatches a `dragenter` event. * @param target - point for emitting `dragenter` event - * ``` */ async dragEnter(target: Point, data: Protocol.Input.DragData): Promise { await this._client.send('Input.dispatchDragEvent', { @@ -524,7 +522,6 @@ export class Mouse { /** * Dispatches a `dragover` event. * @param target - point for emitting `dragover` event - * ``` */ async dragOver(target: Point, data: Protocol.Input.DragData): Promise { await this._client.send('Input.dispatchDragEvent', { @@ -543,7 +540,6 @@ export class Mouse { * @param options - An object of options. Accepts delay which, * if specified, is the time to wait between `dragover` and `drop` in milliseconds. * Defaults to 0. - * ``` */ async drop(target: Point, data: Protocol.Input.DragData): Promise { await this._client.send('Input.dispatchDragEvent', { @@ -562,7 +558,6 @@ export class Mouse { * @param options - An object of options. Accepts delay which, * if specified, is the time to wait between `dragover` and `drop` in milliseconds. * Defaults to 0. - * ``` */ async dragAndDrop( start: Point, diff --git a/src/common/Page.ts b/src/common/Page.ts index aaede4de4554b..5343e2de90deb 100644 --- a/src/common/Page.ts +++ b/src/common/Page.ts @@ -1636,10 +1636,9 @@ export class Page extends EventEmitter { * or {@link Page.setDefaultTimeout | page.setDefaultTimeout(timeout)} * methods. * - * - `waitUntil`: <"load"|"domcontentloaded"|"networkidle0"|"networkidle2"|Array> - * When to consider setting markup succeeded, defaults to `load`. Given an - * array of event strings, setting content is considered to be successful - * after all events have been fired. Events can be either:
+ * - `waitUntil`: When to consider setting markup succeeded, defaults to `load`. + * Given an array of event strings, setting content is considered to be + * successful after all events have been fired. Events can be either:
* - `load` : consider setting content to be finished when the `load` event is * fired.
* - `domcontentloaded` : consider setting content to be finished when the @@ -1671,11 +1670,9 @@ export class Page extends EventEmitter { * or {@link Page.setDefaultTimeout | page.setDefaultTimeout(timeout)} * methods. * - * - `waitUntil`: - * <"load"|"domcontentloaded"|"networkidle0"|"networkidle2"|Array> When to - * consider navigation succeeded, defaults to `load`. Given an array of - * event strings, navigation is considered to be successful after all events - * have been fired. Events can be either:
+ * - `waitUntil`:When to consider navigation succeeded, defaults to `load`. + * Given an array of event strings, navigation is considered to be successful + * after all events have been fired. Events can be either:
* - `load` : consider navigation to be finished when the load event is * fired.
* - `domcontentloaded` : consider navigation to be finished when the @@ -1735,10 +1732,9 @@ export class Page extends EventEmitter { * or {@link Page.setDefaultTimeout | page.setDefaultTimeout(timeout)} * methods. * - * - `waitUntil`: <"load"|"domcontentloaded"|"networkidle0"|"networkidle2"|Array> - * When to consider navigation succeeded, defaults to `load`. Given an array - * of event strings, navigation is considered to be successful after all - * events have been fired. Events can be either:
+ * - `waitUntil`: When to consider navigation succeeded, defaults to `load`. + * Given an array of event strings, navigation is considered to be + * successful after all events have been fired. Events can be either:
* - `load` : consider navigation to be finished when the load event is fired.
* - `domcontentloaded` : consider navigation to be finished when the * DOMContentLoaded event is fired.
@@ -1905,10 +1901,9 @@ export class Page extends EventEmitter { * or {@link Page.setDefaultTimeout | page.setDefaultTimeout(timeout)} * methods. * - * - `waitUntil` : <"load"|"domcontentloaded"|"networkidle0"|"networkidle2"|Array> - * When to consider navigation succeeded, defaults to `load`. Given an array - * of event strings, navigation is considered to be successful after all - * events have been fired. Events can be either:
+ * - `waitUntil` : When to consider navigation succeeded, defaults to `load`. + * Given an array of event strings, navigation is considered to be + * successful after all events have been fired. Events can be either:
* - `load` : consider navigation to be finished when the load event is fired.
* - `domcontentloaded` : consider navigation to be finished when the * DOMContentLoaded event is fired.
@@ -1938,10 +1933,9 @@ export class Page extends EventEmitter { * or {@link Page.setDefaultTimeout | page.setDefaultTimeout(timeout)} * methods. * - * - `waitUntil`: <"load"|"domcontentloaded"|"networkidle0"|"networkidle2"|Array> - * When to consider navigation succeeded, defaults to `load`. Given an array - * of event strings, navigation is considered to be successful after all - * events have been fired. Events can be either:
+ * - `waitUntil`: When to consider navigation succeeded, defaults to `load`. + * Given an array of event strings, navigation is considered to be + * successful after all events have been fired. Events can be either:
* - `load` : consider navigation to be finished when the load event is fired.
* - `domcontentloaded` : consider navigation to be finished when the * DOMContentLoaded event is fired.
@@ -2272,7 +2266,7 @@ export class Page extends EventEmitter { * await page.goto('https://example.com'); * ``` * - * @param viewport + * @param viewport - * @remarks * Argument viewport have following properties: * @@ -2721,7 +2715,7 @@ export class Page extends EventEmitter { } /** - * @param {!PDFOptions=} options + * @param {!PDFOptions=} options - * @returns {!Promise} */ async pdf(options: PDFOptions = {}): Promise { @@ -2848,8 +2842,9 @@ export class Page extends EventEmitter { * page.select('select#colors', 'blue'); // single selection * page.select('select#colors', 'red', 'green', 'blue'); // multiple selections * ``` - * @param selector - A {@link https://developer.mozilla.org/en-US/docs/Web/CSS/ - * CSS_Selectors | Selector} to query the page for + * @param selector - A + * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors | Selector} + * to query the page for * @param values - Values of options to select. If the `