puppeteer/utils/doclint/check_public_api/Documentation.js

158 lines
4.3 KiB
JavaScript
Raw Normal View History

/**
* Copyright 2017 Google Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
class Documentation {
/**
* @param {!Array<!Documentation.Class>} classesArray
*/
constructor(classesArray) {
this.classesArray = classesArray;
/** @type {!Map<string, !Documentation.Class>} */
this.classes = new Map();
2020-05-07 10:54:55 +00:00
for (const cls of classesArray) this.classes.set(cls.name, cls);
}
}
Documentation.Class = class {
/**
* @param {string} name
* @param {!Array<!Documentation.Member>} membersArray
* @param {?string=} extendsName
* @param {string=} comment
*/
constructor(name, membersArray, extendsName = null, comment = '') {
this.name = name;
this.membersArray = membersArray;
/** @type {!Map<string, !Documentation.Member>} */
this.members = new Map();
/** @type {!Map<string, !Documentation.Member>} */
this.properties = new Map();
/** @type {!Array<!Documentation.Member>} */
this.propertiesArray = [];
/** @type {!Map<string, !Documentation.Member>} */
this.methods = new Map();
/** @type {!Array<!Documentation.Member>} */
this.methodsArray = [];
/** @type {!Map<string, !Documentation.Member>} */
this.events = new Map();
/** @type {!Array<!Documentation.Member>} */
this.eventsArray = [];
this.comment = comment;
this.extends = extendsName;
for (const member of membersArray) {
this.members.set(member.name, member);
if (member.kind === 'method') {
this.methods.set(member.name, member);
this.methodsArray.push(member);
} else if (member.kind === 'property') {
this.properties.set(member.name, member);
this.propertiesArray.push(member);
} else if (member.kind === 'event') {
this.events.set(member.name, member);
this.eventsArray.push(member);
}
}
}
};
Documentation.Member = class {
/**
* @param {string} kind
* @param {string} name
* @param {?Documentation.Type} type
* @param {!Array<!Documentation.Member>} argsArray
*/
2020-05-07 10:54:55 +00:00
constructor(
kind,
name,
type,
argsArray,
comment = '',
returnComment = '',
required = true
) {
this.kind = kind;
this.name = name;
this.type = type;
this.comment = comment;
this.returnComment = returnComment;
this.argsArray = argsArray;
this.required = required;
/** @type {!Map<string, !Documentation.Member>} */
this.args = new Map();
2020-05-07 10:54:55 +00:00
for (const arg of argsArray) this.args.set(arg.name, arg);
}
/**
* @param {string} name
* @param {!Array<!Documentation.Member>} argsArray
* @param {?Documentation.Type} returnType
* @returns {!Documentation.Member}
*/
static createMethod(name, argsArray, returnType, returnComment, comment) {
2020-05-07 10:54:55 +00:00
return new Documentation.Member(
'method',
name,
returnType,
argsArray,
comment,
returnComment
);
}
/**
* @param {string} name
* @param {!Documentation.Type} type
* @param {string=} comment
* @param {boolean=} required
* @returns {!Documentation.Member}
*/
static createProperty(name, type, comment, required) {
2020-05-07 10:54:55 +00:00
return new Documentation.Member(
'property',
name,
type,
[],
comment,
undefined,
required
);
}
/**
* @param {string} name
* @param {?Documentation.Type=} type
* @param {string=} comment
* @returns {!Documentation.Member}
*/
static createEvent(name, type = null, comment) {
return new Documentation.Member('event', name, type, [], comment);
}
};
Documentation.Type = class {
/**
* @param {string} name
* @param {!Array<!Documentation.Member>=} properties
*/
constructor(name, properties = []) {
this.name = name;
this.properties = properties;
}
};
module.exports = Documentation;