github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(doclint): exclude constructors by default (#938)

Browse Source 
Our API does not expose any classes; thus all the constructors
should be excluded from the API.
This commit is contained in:
Andrey Lushnikov 2017-10-02 14:28:51 -07:00 committed by GitHub
parent 6c9a99477b
commit 017429eef1
1 changed files with 3 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
utils/doclint/check_public_api/index.js
View File

@ -35,22 +35,8 @@ const EXCLUDE_CLASSES = new Set([
]);
const EXCLUDE_METHODS = new Set([
'Body.constructor',
'Browser.constructor',
'ConsoleMessage.constructor',
'Dialog.constructor',
'ElementHandle.constructor',
'Frame.constructor',
'Headers.constructor',
'Headers.fromPayload',
'Keyboard.constructor',
'Mouse.constructor',
'Touchscreen.constructor',
'Tracing.constructor',
'Page.constructor',
'Page.create',
'Request.constructor',
'Response.constructor',
]);
/**
@ -145,6 +131,9 @@ function filterJSDocumentation(jsDocumentation) {
const members = cls.membersArray.filter(member => {
if (member.name.startsWith('_'))
return false;
// Exclude all constructors by default.
if (member.name === 'constructor' && member.type === 'method')
return false;
return !EXCLUDE_METHODS.has(`${cls.name}.${member.name}`);
});
classes.push(new Documentation.Class(cls.name, members));