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

[doclint] introduce class members

Browse Source 
This patch unifies Documentation.Method with Documentation.Property,
making it possible to verify sorting order across methods and
properties.

References #14.
This commit is contained in:
Andrey Lushnikov
2017-07-13 22:52:02 -07:00
parent 880575c71d
commit 45c20c7dad
8 changed files with 97 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
utils/doclint/MDBuilder.js
View File

@@ -53,8 +53,7 @@ class MDOutline {
const methodRegex = /^(\w+)\.(\w+)\((.*)\)$/;
const propertyRegex = /^(\w+)\.(\w+)$/;
let currentClassName = null;
let currentClassMethods = [];
let currentClassProperties = [];
let currentClassMembers = [];
for (const cls of classes) {
let match = cls.name.match(classHeading);
if (!match)
@@ -84,8 +83,8 @@ class MDOutline {
if (parameters !== member.args.join(', '))
this.errors.push(`Heading arguments for "${member.name}" do not match described ones, i.e. "${parameters}" != "${member.args.join(', ')}"`);
let args = member.args.map(arg => new Documentation.Argument(arg));
let method = new Documentation.Method(methodName, args);
currentClassMethods.push(method);
let method = Documentation.Member.createMethod(methodName, args);
currentClassMembers.push(method);
}
function handleProperty(member, className, propertyName) {
@@ -93,16 +92,15 @@ class MDOutline {
this.errors.push(`Failed to process header as property: ${member.name}`);
return;
}
currentClassProperties.push(propertyName);
currentClassMembers.push(Documentation.Member.createProperty(propertyName));
}
function flushClassIfNeeded() {
if (currentClassName === null)
return;
this.classes.push(new Documentation.Class(currentClassName, currentClassMethods, currentClassProperties));
this.classes.push(new Documentation.Class(currentClassName, currentClassMembers));
currentClassName = null;
currentClassMethods = [];
currentClassProperties = [];
currentClassMembers = [];
}
}
}