chore(docs): reduce warnings when generating docs (#6138)

* chore(docs): reduce warnings when generating docs This is a bunch of small miscellaneous fixes that reduce the amount of warnings logged when generating our new docs. The long term goal is to get this list down to 0 warnings, but I'll do it in multiple PRs. * satisfy doclint
puppeteer · Jul 2, 2020 · 29f7e16 · 29f7e16
1 parent 221d172
commit 29f7e16
Show file tree

Hide file tree

Showing 94 changed files with 755 additions and 289 deletions.
diff --git a/api-extractor.json b/api-extractor.json
@@ -27,6 +27,9 @@
     },
 
     "extractorMessageReporting": {
+      "ae-internal-missing-underscore": {
+        "logLevel": "none"
+      },
       "default": {
         "logLevel": "warning"
       }

diff --git a/new-docs/puppeteer.browserfetcher.download.md b/new-docs/puppeteer.browserfetcher.download.md
@@ -21,7 +21,7 @@ download(revision: string, progressCallback?: (x: number, y: number) => void): P
 
 <b>Returns:</b>
 
-Promise&lt;BrowserFetcherRevisionInfo&gt;
+Promise&lt;[BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md)<!-- -->&gt;
 
 A promise with revision information when the revision is downloaded and extracted.
 

diff --git a/new-docs/puppeteer.browserfetcher.platform.md b/new-docs/puppeteer.browserfetcher.platform.md
@@ -11,7 +11,7 @@ platform(): Platform;
 ```
 <b>Returns:</b>
 
-Platform
+[Platform](./puppeteer.platform.md)
 
 Returns the current `Platform`<!-- -->.
 
diff --git a/new-docs/puppeteer.browserfetcher.product.md b/new-docs/puppeteer.browserfetcher.product.md
@@ -11,7 +11,7 @@ product(): Product;
 ```
 <b>Returns:</b>
 
-Product
+[Product](./puppeteer.product.md)
 
 Returns the current `Product`<!-- -->.
 
diff --git a/new-docs/puppeteer.browserfetcher.revisioninfo.md b/new-docs/puppeteer.browserfetcher.revisioninfo.md
@@ -18,7 +18,7 @@ revisionInfo(revision: string): BrowserFetcherRevisionInfo;
 
 <b>Returns:</b>
 
-BrowserFetcherRevisionInfo
+[BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md)
 
 The revision info for the given revision.
 
diff --git a/new-docs/puppeteer.browserfetcheroptions.md b/new-docs/puppeteer.browserfetcheroptions.md
@@ -4,6 +4,7 @@
 
 ## BrowserFetcherOptions interface
 
+
 <b>Signature:</b>
 
 ```typescript
@@ -16,6 +17,6 @@ export interface BrowserFetcherOptions
 |  --- | --- | --- |
 |  [host](./puppeteer.browserfetcheroptions.host.md) | string |  |
 |  [path](./puppeteer.browserfetcheroptions.path.md) | string |  |
-|  [platform](./puppeteer.browserfetcheroptions.platform.md) | Platform |  |
+|  [platform](./puppeteer.browserfetcheroptions.platform.md) | [Platform](./puppeteer.platform.md) |  |
 |  [product](./puppeteer.browserfetcheroptions.product.md) | string |  |
 
diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.executablepath.md b/new-docs/puppeteer.browserfetcherrevisioninfo.executablepath.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) &gt; [executablePath](./puppeteer.browserfetcherrevisioninfo.executablepath.md)
+
+## BrowserFetcherRevisionInfo.executablePath property
+
+<b>Signature:</b>
+
+```typescript
+executablePath: string;
+```
diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.folderpath.md b/new-docs/puppeteer.browserfetcherrevisioninfo.folderpath.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) &gt; [folderPath](./puppeteer.browserfetcherrevisioninfo.folderpath.md)
+
+## BrowserFetcherRevisionInfo.folderPath property
+
+<b>Signature:</b>
+
+```typescript
+folderPath: string;
+```
diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.local.md b/new-docs/puppeteer.browserfetcherrevisioninfo.local.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) &gt; [local](./puppeteer.browserfetcherrevisioninfo.local.md)
+
+## BrowserFetcherRevisionInfo.local property
+
+<b>Signature:</b>
+
+```typescript
+local: boolean;
+```
diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.md b/new-docs/puppeteer.browserfetcherrevisioninfo.md
@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md)
+
+## BrowserFetcherRevisionInfo interface
+
+
+<b>Signature:</b>
+
+```typescript
+export interface BrowserFetcherRevisionInfo 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [executablePath](./puppeteer.browserfetcherrevisioninfo.executablepath.md) | string |  |
+|  [folderPath](./puppeteer.browserfetcherrevisioninfo.folderpath.md) | string |  |
+|  [local](./puppeteer.browserfetcherrevisioninfo.local.md) | boolean |  |
+|  [product](./puppeteer.browserfetcherrevisioninfo.product.md) | string |  |
+|  [revision](./puppeteer.browserfetcherrevisioninfo.revision.md) | string |  |
+|  [url](./puppeteer.browserfetcherrevisioninfo.url.md) | string |  |
+
diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.product.md b/new-docs/puppeteer.browserfetcherrevisioninfo.product.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) &gt; [product](./puppeteer.browserfetcherrevisioninfo.product.md)
+
+## BrowserFetcherRevisionInfo.product property
+
+<b>Signature:</b>
+
+```typescript
+product: string;
+```
diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.revision.md b/new-docs/puppeteer.browserfetcherrevisioninfo.revision.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) &gt; [revision](./puppeteer.browserfetcherrevisioninfo.revision.md)
+
+## BrowserFetcherRevisionInfo.revision property
+
+<b>Signature:</b>
+
+```typescript
+revision: string;
+```
diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.url.md b/new-docs/puppeteer.browserfetcherrevisioninfo.url.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) &gt; [url](./puppeteer.browserfetcherrevisioninfo.url.md)
+
+## BrowserFetcherRevisionInfo.url property
+
+<b>Signature:</b>
+
+```typescript
+url: string;
+```
diff --git a/new-docs/puppeteer.browseroptions.defaultviewport.md b/new-docs/puppeteer.browseroptions.defaultviewport.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserOptions](./puppeteer.browseroptions.md) &gt; [defaultViewport](./puppeteer.browseroptions.defaultviewport.md)
+
+## BrowserOptions.defaultViewport property
+
+<b>Signature:</b>
+
+```typescript
+defaultViewport?: Viewport;
+```
diff --git a/new-docs/puppeteer.browseroptions.ignorehttpserrors.md b/new-docs/puppeteer.browseroptions.ignorehttpserrors.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserOptions](./puppeteer.browseroptions.md) &gt; [ignoreHTTPSErrors](./puppeteer.browseroptions.ignorehttpserrors.md)
+
+## BrowserOptions.ignoreHTTPSErrors property
+
+<b>Signature:</b>
+
+```typescript
+ignoreHTTPSErrors?: boolean;
+```
diff --git a/new-docs/puppeteer.browseroptions.md b/new-docs/puppeteer.browseroptions.md
@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserOptions](./puppeteer.browseroptions.md)
+
+## BrowserOptions interface
+
+Generic browser options that can be passed when launching any browser.
+
+<b>Signature:</b>
+
+```typescript
+export interface BrowserOptions 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [defaultViewport](./puppeteer.browseroptions.defaultviewport.md) | Viewport |  |
+|  [ignoreHTTPSErrors](./puppeteer.browseroptions.ignorehttpserrors.md) | boolean |  |
+|  [slowMo](./puppeteer.browseroptions.slowmo.md) | number |  |
+
diff --git a/new-docs/puppeteer.browseroptions.slowmo.md b/new-docs/puppeteer.browseroptions.slowmo.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserOptions](./puppeteer.browseroptions.md) &gt; [slowMo](./puppeteer.browseroptions.slowmo.md)
+
+## BrowserOptions.slowMo property
+
+<b>Signature:</b>
+
+```typescript
+slowMo?: number;
+```
diff --git a/new-docs/puppeteer.chromeargoptions.args.md b/new-docs/puppeteer.chromeargoptions.args.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ChromeArgOptions](./puppeteer.chromeargoptions.md) &gt; [args](./puppeteer.chromeargoptions.args.md)
+
+## ChromeArgOptions.args property
+
+<b>Signature:</b>
+
+```typescript
+args?: string[];
+```
diff --git a/new-docs/puppeteer.chromeargoptions.devtools.md b/new-docs/puppeteer.chromeargoptions.devtools.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ChromeArgOptions](./puppeteer.chromeargoptions.md) &gt; [devtools](./puppeteer.chromeargoptions.devtools.md)
+
+## ChromeArgOptions.devtools property
+
+<b>Signature:</b>
+
+```typescript
+devtools?: boolean;
+```
diff --git a/new-docs/puppeteer.chromeargoptions.headless.md b/new-docs/puppeteer.chromeargoptions.headless.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ChromeArgOptions](./puppeteer.chromeargoptions.md) &gt; [headless](./puppeteer.chromeargoptions.headless.md)
+
+## ChromeArgOptions.headless property
+
+<b>Signature:</b>
+
+```typescript
+headless?: boolean;
+```
diff --git a/new-docs/puppeteer.chromeargoptions.md b/new-docs/puppeteer.chromeargoptions.md
@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ChromeArgOptions](./puppeteer.chromeargoptions.md)
+
+## ChromeArgOptions interface
+
+Launcher options that only apply to Chrome.
+
+<b>Signature:</b>
+
+```typescript
+export interface ChromeArgOptions 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [args](./puppeteer.chromeargoptions.args.md) | string\[\] |  |
+|  [devtools](./puppeteer.chromeargoptions.devtools.md) | boolean |  |
+|  [headless](./puppeteer.chromeargoptions.headless.md) | boolean |  |
+|  [userDataDir](./puppeteer.chromeargoptions.userdatadir.md) | string |  |
+
diff --git a/new-docs/puppeteer.chromeargoptions.userdatadir.md b/new-docs/puppeteer.chromeargoptions.userdatadir.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ChromeArgOptions](./puppeteer.chromeargoptions.md) &gt; [userDataDir](./puppeteer.chromeargoptions.userdatadir.md)
+
+## ChromeArgOptions.userDataDir property
+
+<b>Signature:</b>
+
+```typescript
+userDataDir?: string;
+```
diff --git a/new-docs/puppeteer.devicesmap.md b/new-docs/puppeteer.devicesmap.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [devicesMap](./puppeteer.devicesmap.md)
+
+## devicesMap variable
+
+<b>Signature:</b>
+
+```typescript
+devicesMap: DevicesMap
+```
diff --git a/new-docs/puppeteer.frame.click.md b/new-docs/puppeteer.frame.click.md
@@ -9,7 +9,7 @@
 ```typescript
 click(selector: string, options?: {
         delay?: number;
-        button?: MouseButtonInput;
+        button?: MouseButton;
         clickCount?: number;
     }): Promise<void>;
 ```
@@ -19,7 +19,7 @@ click(selector: string, options?: {
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  selector | string |  |
-|  options | { delay?: number; button?: [MouseButtonInput](./puppeteer.mousebuttoninput.md)<!-- -->; clickCount?: number; } |  |
+|  options | { delay?: number; button?: [MouseButton](./puppeteer.mousebutton.md)<!-- -->; clickCount?: number; } |  |
 
 <b>Returns:</b>
 

diff --git a/new-docs/puppeteer.keydefinition.code.md b/new-docs/puppeteer.keydefinition.code.md
diff --git a/new-docs/puppeteer.keydefinition.key.md b/new-docs/puppeteer.keydefinition.key.md
diff --git a/new-docs/puppeteer.keydefinition.keycode.md b/new-docs/puppeteer.keydefinition.keycode.md
diff --git a/new-docs/puppeteer.keydefinition.location.md b/new-docs/puppeteer.keydefinition.location.md