Skip to content

Commit fd5b2e7

Browse files
committed
docs: inline superclass toc into classes for convenience
1 parent 4b84973 commit fd5b2e7

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

docs/api.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -666,6 +666,15 @@ ElementHandle instances can be used as arguments in [`page.$eval()`](#pageevalse
666666
- [elementHandle.type(text[, options])](#elementhandletypetext-options)
667667
- [elementHandle.visibleRatio()](#elementhandlevisibleratio)
668668
<!-- GEN:stop -->
669+
<!-- GEN:toc-extends-JSHandle -->
670+
- [jsHandle.asElement()](#jshandleaselement)
671+
- [jsHandle.dispose()](#jshandledispose)
672+
- [jsHandle.evaluate(pageFunction[, ...args])](#jshandleevaluatepagefunction-args)
673+
- [jsHandle.evaluateHandle(pageFunction[, ...args])](#jshandleevaluatehandlepagefunction-args)
674+
- [jsHandle.getProperties()](#jshandlegetproperties)
675+
- [jsHandle.getProperty(propertyName)](#jshandlegetpropertypropertyname)
676+
- [jsHandle.jsonValue()](#jshandlejsonvalue)
677+
<!-- GEN:stop -->
669678

670679
#### elementHandle.$(selector)
671680
- `selector` <[string]> A selector to query element for
@@ -3459,6 +3468,15 @@ await browser.stopTracing();
34593468
- [chromiumBrowser.targets(context)](#chromiumbrowsertargetscontext)
34603469
- [chromiumBrowser.waitForTarget(predicate[, options])](#chromiumbrowserwaitfortargetpredicate-options)
34613470
<!-- GEN:stop -->
3471+
<!-- GEN:toc-extends-Browser -->
3472+
- [event: 'disconnected'](#event-disconnected)
3473+
- [browser.browserContexts()](#browserbrowsercontexts)
3474+
- [browser.close()](#browserclose)
3475+
- [browser.defaultContext()](#browserdefaultcontext)
3476+
- [browser.disconnect()](#browserdisconnect)
3477+
- [browser.isConnected()](#browserisconnected)
3478+
- [browser.newContext(options)](#browsernewcontextoptions)
3479+
<!-- GEN:stop -->
34623480

34633481
#### event: 'targetchanged'
34643482
- <[Target]>
@@ -3617,12 +3635,32 @@ Identifies what kind of target this is. Can be `"page"`, [`"background_page"`](h
36173635

36183636
Firefox browser instance does not expose Firefox-specific features.
36193637

3638+
<!-- GEN:toc-extends-Browser -->
3639+
- [event: 'disconnected'](#event-disconnected)
3640+
- [browser.browserContexts()](#browserbrowsercontexts)
3641+
- [browser.close()](#browserclose)
3642+
- [browser.defaultContext()](#browserdefaultcontext)
3643+
- [browser.disconnect()](#browserdisconnect)
3644+
- [browser.isConnected()](#browserisconnected)
3645+
- [browser.newContext(options)](#browsernewcontextoptions)
3646+
<!-- GEN:stop -->
3647+
36203648
### class: WebKitBrowser
36213649

36223650
* extends: [Browser]
36233651

36243652
WebKit browser instance does not expose WebKit-specific features.
36253653

3654+
<!-- GEN:toc-extends-Browser -->
3655+
- [event: 'disconnected'](#event-disconnected)
3656+
- [browser.browserContexts()](#browserbrowsercontexts)
3657+
- [browser.close()](#browserclose)
3658+
- [browser.defaultContext()](#browserdefaultcontext)
3659+
- [browser.disconnect()](#browserdisconnect)
3660+
- [browser.isConnected()](#browserisconnected)
3661+
- [browser.newContext(options)](#browsernewcontextoptions)
3662+
<!-- GEN:stop -->
3663+
36263664
### Working with selectors
36273665

36283666
Selector describes an element in the page. It can be used to obtain `ElementHandle` (see [page.$()](#pageselector) for example) or shortcut element operations to avoid intermediate handle (see [page.click()](#pageclickselector-options) for example).

utils/doclint/preprocessor/index.js

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ module.exports.runCommands = function(sources, version) {
7272
newText = generateTableOfContents(command.source.text(), command.to, false /* topLevelOnly */);
7373
else if (command.name === 'toc-top-level')
7474
newText = generateTableOfContents(command.source.text(), command.to, true /* topLevelOnly */);
75+
else if (command.name.startsWith('toc-extends-'))
76+
newText = generateTableOfContentsForSuperclass(command.source.text(), 'class: ' + command.name.substring('toc-extends-'.length));
7577
if (newText === null)
7678
messages.push(Message.error(`Unknown command 'gen:${command.name}'`));
7779
else if (applyCommand(command, newText))
@@ -152,3 +154,21 @@ function generateTableOfContents(text, offset, topLevelOnly) {
152154
return `${padding}${prefix} [${entry.name}](#${entry.id})`;
153155
}).join('\n') + '\n';
154156
}
157+
158+
function generateTableOfContentsForSuperclass(text, name) {
159+
const allTocEntries = getTOCEntriesForText(text);
160+
161+
for (const tocEntry of allTocEntries) {
162+
if (tocEntry.name !== name)
163+
continue;
164+
const offset = text.indexOf('<!-- GEN:stop -->', tocEntry.offset);
165+
log = true;
166+
try {
167+
const result = generateTableOfContents(text, offset, false);
168+
return result;
169+
} finally {
170+
log = false;
171+
}
172+
}
173+
return text;
174+
}

0 commit comments

Comments
 (0)