docs(new): migrate Target to TSDoc (#6067)

* docs(new): migrate Target to TSDoc Co-authored-by: Alex Rudenko <alexrudenko@chromium.org>
puppeteer · Jun 22, 2020 · 7025f1c · 7025f1c
1 parent 819afbe
commit 7025f1c
Show file tree

Hide file tree

Showing 23 changed files with 79 additions and 226 deletions.
diff --git a/new-docs/puppeteer.target._browsercontext.md b/new-docs/puppeteer.target._browsercontext.md
diff --git a/new-docs/puppeteer.target._closedcallback.md b/new-docs/puppeteer.target._closedcallback.md
diff --git a/new-docs/puppeteer.target._constructor_.md b/new-docs/puppeteer.target._constructor_.md
diff --git a/new-docs/puppeteer.target._defaultviewport.md b/new-docs/puppeteer.target._defaultviewport.md
diff --git a/new-docs/puppeteer.target._ignorehttpserrors.md b/new-docs/puppeteer.target._ignorehttpserrors.md
diff --git a/new-docs/puppeteer.target._initializedcallback.md b/new-docs/puppeteer.target._initializedcallback.md
diff --git a/new-docs/puppeteer.target._initializedpromise.md b/new-docs/puppeteer.target._initializedpromise.md
diff --git a/new-docs/puppeteer.target._isclosedpromise.md b/new-docs/puppeteer.target._isclosedpromise.md
diff --git a/new-docs/puppeteer.target._isinitialized.md b/new-docs/puppeteer.target._isinitialized.md
diff --git a/new-docs/puppeteer.target._pagepromise.md b/new-docs/puppeteer.target._pagepromise.md
diff --git a/new-docs/puppeteer.target._sessionfactory.md b/new-docs/puppeteer.target._sessionfactory.md
diff --git a/new-docs/puppeteer.target._targetid.md b/new-docs/puppeteer.target._targetid.md
diff --git a/new-docs/puppeteer.target._targetinfo.md b/new-docs/puppeteer.target._targetinfo.md
diff --git a/new-docs/puppeteer.target._targetinfochanged.md b/new-docs/puppeteer.target._targetinfochanged.md
diff --git a/new-docs/puppeteer.target._workerpromise.md b/new-docs/puppeteer.target._workerpromise.md
diff --git a/new-docs/puppeteer.target.browser.md b/new-docs/puppeteer.target.browser.md
@@ -4,6 +4,8 @@
 
 ## Target.browser() method
 
+Get the browser the target belongs to.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/new-docs/puppeteer.target.createcdpsession.md b/new-docs/puppeteer.target.createcdpsession.md
@@ -4,6 +4,8 @@
 
 ## Target.createCDPSession() method
 
+Creates a Chrome Devtools Protocol session attached to the target.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/new-docs/puppeteer.target.md b/new-docs/puppeteer.target.md
@@ -10,41 +10,20 @@
 export declare class Target 
 ```
 
-## Constructors
+## Remarks
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(targetInfo, browserContext, sessionFactory, ignoreHTTPSErrors, defaultViewport)](./puppeteer.target._constructor_.md) |  | Constructs a new instance of the <code>Target</code> class |
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [\_browserContext](./puppeteer.target._browsercontext.md) |  | [BrowserContext](./puppeteer.browsercontext.md) |  |
-|  [\_closedCallback](./puppeteer.target._closedcallback.md) |  | () =&gt; void |  |
-|  [\_defaultViewport](./puppeteer.target._defaultviewport.md) |  | Viewport |  |
-|  [\_ignoreHTTPSErrors](./puppeteer.target._ignorehttpserrors.md) |  | boolean |  |
-|  [\_initializedCallback](./puppeteer.target._initializedcallback.md) |  | (x: boolean) =&gt; void |  |
-|  [\_initializedPromise](./puppeteer.target._initializedpromise.md) |  | Promise&lt;boolean&gt; |  |
-|  [\_isClosedPromise](./puppeteer.target._isclosedpromise.md) |  | Promise&lt;boolean&gt; |  |
-|  [\_isInitialized](./puppeteer.target._isinitialized.md) |  | boolean |  |
-|  [\_pagePromise](./puppeteer.target._pagepromise.md) |  | Promise&lt;[Page](./puppeteer.page.md)<!-- -->&gt; |  |
-|  [\_sessionFactory](./puppeteer.target._sessionfactory.md) |  | () =&gt; Promise&lt;[CDPSession](./puppeteer.cdpsession.md)<!-- -->&gt; |  |
-|  [\_targetId](./puppeteer.target._targetid.md) |  | string |  |
-|  [\_targetInfo](./puppeteer.target._targetinfo.md) |  | Protocol.Target.TargetInfo |  |
-|  [\_workerPromise](./puppeteer.target._workerpromise.md) |  | Promise&lt;[WebWorker](./puppeteer.webworker.md)<!-- -->&gt; |  |
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Target` class.
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [\_targetInfoChanged(targetInfo)](./puppeteer.target._targetinfochanged.md) |  |  |
-|  [browser()](./puppeteer.target.browser.md) |  |  |
+|  [browser()](./puppeteer.target.browser.md) |  | Get the browser the target belongs to. |
 |  [browserContext()](./puppeteer.target.browsercontext.md) |  |  |
-|  [createCDPSession()](./puppeteer.target.createcdpsession.md) |  |  |
-|  [opener()](./puppeteer.target.opener.md) |  |  |
-|  [page()](./puppeteer.target.page.md) |  |  |
-|  [type()](./puppeteer.target.type.md) |  |  |
+|  [createCDPSession()](./puppeteer.target.createcdpsession.md) |  | Creates a Chrome Devtools Protocol session attached to the target. |
+|  [opener()](./puppeteer.target.opener.md) |  | Get the target that opened this target. Top-level targets return <code>null</code>. |
+|  [page()](./puppeteer.target.page.md) |  | If the target is not of type <code>&quot;page&quot;</code> or <code>&quot;background_page&quot;</code>, returns <code>null</code>. |
+|  [type()](./puppeteer.target.type.md) |  | Identifies what kind of target this is. |
 |  [url()](./puppeteer.target.url.md) |  |  |
-|  [worker()](./puppeteer.target.worker.md) |  |  |
+|  [worker()](./puppeteer.target.worker.md) |  | If the target is not of type <code>&quot;service_worker&quot;</code> or <code>&quot;shared_worker&quot;</code>, returns <code>null</code>. |
 
diff --git a/new-docs/puppeteer.target.opener.md b/new-docs/puppeteer.target.opener.md
@@ -4,6 +4,8 @@
 
 ## Target.opener() method
 
+Get the target that opened this target. Top-level targets return `null`<!-- -->.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/new-docs/puppeteer.target.page.md b/new-docs/puppeteer.target.page.md
@@ -4,6 +4,8 @@
 
 ## Target.page() method
 
+If the target is not of type `"page"` or `"background_page"`<!-- -->, returns `null`<!-- -->.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/new-docs/puppeteer.target.type.md b/new-docs/puppeteer.target.type.md
@@ -4,6 +4,8 @@
 
 ## Target.type() method
 
+Identifies what kind of target this is.
+
 <b>Signature:</b>
 
 ```typescript
@@ -13,3 +15,7 @@ type(): 'page' | 'background_page' | 'service_worker' | 'shared_worker' | 'other
 
 'page' \| 'background\_page' \| 'service\_worker' \| 'shared\_worker' \| 'other' \| 'browser' \| 'webview'
 
+## Remarks
+
+See [docs](https://developer.chrome.com/extensions/background_pages) for more info about background pages.
+
diff --git a/new-docs/puppeteer.target.worker.md b/new-docs/puppeteer.target.worker.md
@@ -4,6 +4,8 @@
 
 ## Target.worker() method
 
+If the target is not of type `"service_worker"` or `"shared_worker"`<!-- -->, returns `null`<!-- -->.
+
 <b>Signature:</b>
 
 ```typescript