/** * 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} classesArray */ constructor(classesArray) { this.classesArray = classesArray; /** @type {!Map} */ this.classes = new Map(); for (const cls of classesArray) this.classes.set(cls.name, cls); } } Documentation.Class = class { /** * @param {string} name * @param {!Array} membersArray * @param {?string=} extendsName * @param {string=} comment */ constructor(name, membersArray, extendsName = null, comment = '') { this.name = name; this.membersArray = membersArray; /** @type {!Map} */ this.members = new Map(); /** @type {!Map} */ this.properties = new Map(); /** @type {!Array} */ this.propertiesArray = []; /** @type {!Map} */ this.methods = new Map(); /** @type {!Array} */ this.methodsArray = []; /** @type {!Map} */ this.events = new Map(); /** @type {!Array} */ 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} argsArray */ 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} */ this.args = new Map(); for (const arg of argsArray) this.args.set(arg.name, arg); } /** * @param {string} name * @param {!Array} argsArray * @param {?Documentation.Type} returnType * @return {!Documentation.Member} */ static createMethod(name, argsArray, returnType, returnComment, comment) { return new Documentation.Member( 'method', name, returnType, argsArray, comment, returnComment ); } /** * @param {string} name * @param {!Documentation.Type} type * @param {string=} comment * @param {boolean=} required * @return {!Documentation.Member} */ static createProperty(name, type, comment, required) { return new Documentation.Member( 'property', name, type, [], comment, undefined, required ); } /** * @param {string} name * @param {?Documentation.Type=} type * @param {string=} comment * @return {!Documentation.Member} */ static createEvent(name, type = null, comment) { return new Documentation.Member('event', name, type, [], comment); } }; Documentation.Type = class { /** * @param {string} name * @param {!Array=} properties */ constructor(name, properties = []) { this.name = name; this.properties = properties; } }; module.exports = Documentation;