chore(docs): fix more documentation warnings (#6145)

puppeteer · Jul 2, 2020 · 054fa2e · 054fa2e
1 parent 928924e
commit 054fa2e
Show file tree

Hide file tree

Showing 60 changed files with 164 additions and 804 deletions.
diff --git a/new-docs/puppeteer.credentials.md b/new-docs/puppeteer.credentials.md
@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Credentials](./puppeteer.credentials.md)
+
+## Credentials interface
+
+
+<b>Signature:</b>
+
+```typescript
+export interface Credentials 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [password](./puppeteer.credentials.password.md) | string |  |
+|  [username](./puppeteer.credentials.username.md) | string |  |
+
diff --git a/new-docs/puppeteer.credentials.password.md b/new-docs/puppeteer.credentials.password.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; [Credentials](./puppeteer.credentials.md) &gt; [password](./puppeteer.credentials.password.md)
+
+## Credentials.password property
+
+<b>Signature:</b>
+
+```typescript
+password: string;
+```
diff --git a/new-docs/puppeteer.credentials.username.md b/new-docs/puppeteer.credentials.username.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; [Credentials](./puppeteer.credentials.md) &gt; [username](./puppeteer.credentials.username.md)
+
+## Credentials.username property
+
+<b>Signature:</b>
+
+```typescript
+username: string;
+```
diff --git a/new-docs/puppeteer.frame._childframes.md b/new-docs/puppeteer.frame._childframes.md
diff --git a/new-docs/puppeteer.frame._client.md b/new-docs/puppeteer.frame._client.md
diff --git a/new-docs/puppeteer.frame._constructor_.md b/new-docs/puppeteer.frame._constructor_.md
diff --git a/new-docs/puppeteer.frame._detached.md b/new-docs/puppeteer.frame._detached.md
diff --git a/new-docs/puppeteer.frame._framemanager.md b/new-docs/puppeteer.frame._framemanager.md
diff --git a/new-docs/puppeteer.frame._id.md b/new-docs/puppeteer.frame._id.md
diff --git a/new-docs/puppeteer.frame._lifecycleevents.md b/new-docs/puppeteer.frame._lifecycleevents.md
diff --git a/new-docs/puppeteer.frame._loaderid.md b/new-docs/puppeteer.frame._loaderid.md
diff --git a/new-docs/puppeteer.frame._mainworld.md b/new-docs/puppeteer.frame._mainworld.md
diff --git a/new-docs/puppeteer.frame._name.md b/new-docs/puppeteer.frame._name.md
diff --git a/new-docs/puppeteer.frame._parentframe.md b/new-docs/puppeteer.frame._parentframe.md
diff --git a/new-docs/puppeteer.frame._secondaryworld.md b/new-docs/puppeteer.frame._secondaryworld.md
diff --git a/new-docs/puppeteer.frame._url.md b/new-docs/puppeteer.frame._url.md
diff --git a/new-docs/puppeteer.frame.md b/new-docs/puppeteer.frame.md
@@ -10,28 +10,9 @@
 export declare class Frame 
 ```
 
-## Constructors
+## Remarks
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(frameManager, client, parentFrame, frameId)](./puppeteer.frame._constructor_.md) |  | Constructs a new instance of the <code>Frame</code> class |
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [\_childFrames](./puppeteer.frame._childframes.md) |  | Set&lt;[Frame](./puppeteer.frame.md)<!-- -->&gt; |  |
-|  [\_client](./puppeteer.frame._client.md) |  | [CDPSession](./puppeteer.cdpsession.md) |  |
-|  [\_detached](./puppeteer.frame._detached.md) |  | boolean |  |
-|  [\_frameManager](./puppeteer.frame._framemanager.md) |  | [FrameManager](./puppeteer.framemanager.md) |  |
-|  [\_id](./puppeteer.frame._id.md) |  | string |  |
-|  [\_lifecycleEvents](./puppeteer.frame._lifecycleevents.md) |  | Set&lt;string&gt; |  |
-|  [\_loaderId](./puppeteer.frame._loaderid.md) |  | string |  |
-|  [\_mainWorld](./puppeteer.frame._mainworld.md) |  | DOMWorld |  |
-|  [\_name](./puppeteer.frame._name.md) |  | string |  |
-|  [\_parentFrame](./puppeteer.frame._parentframe.md) |  | [Frame](./puppeteer.frame.md) |  |
-|  [\_secondaryWorld](./puppeteer.frame._secondaryworld.md) |  | DOMWorld |  |
-|  [\_url](./puppeteer.frame._url.md) |  | string |  |
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Frame` class.
 
 ## Methods
 

diff --git a/new-docs/puppeteer.frame.waitforselector.md b/new-docs/puppeteer.frame.waitforselector.md
@@ -15,7 +15,7 @@ waitForSelector(selector: string, options?: WaitForSelectorOptions): Promise<Ele
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  selector | string |  |
-|  options | WaitForSelectorOptions |  |
+|  options | [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) |  |
 
 <b>Returns:</b>
 

diff --git a/new-docs/puppeteer.frame.waitforxpath.md b/new-docs/puppeteer.frame.waitforxpath.md
@@ -15,7 +15,7 @@ waitForXPath(xpath: string, options?: WaitForSelectorOptions): Promise<ElementHa
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  xpath | string |  |
-|  options | WaitForSelectorOptions |  |
+|  options | [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) |  |
 
 <b>Returns:</b>
 

diff --git a/new-docs/puppeteer.framemanager._client.md b/new-docs/puppeteer.framemanager._client.md
diff --git a/new-docs/puppeteer.framemanager._constructor_.md b/new-docs/puppeteer.framemanager._constructor_.md
diff --git a/new-docs/puppeteer.framemanager._contextidtocontext.md b/new-docs/puppeteer.framemanager._contextidtocontext.md
diff --git a/new-docs/puppeteer.framemanager._ensureisolatedworld.md b/new-docs/puppeteer.framemanager._ensureisolatedworld.md
diff --git a/new-docs/puppeteer.framemanager._frames.md b/new-docs/puppeteer.framemanager._frames.md
diff --git a/new-docs/puppeteer.framemanager._handleframetree.md b/new-docs/puppeteer.framemanager._handleframetree.md
diff --git a/new-docs/puppeteer.framemanager._isolatedworlds.md b/new-docs/puppeteer.framemanager._isolatedworlds.md
diff --git a/new-docs/puppeteer.framemanager._mainframe.md b/new-docs/puppeteer.framemanager._mainframe.md