@@ -17,8 +17,8 @@ module.exports = SwaggerParser;
1717 * This class parses a Swagger 2.0 or 3.0 API, resolves its JSON references and their resolved values,
1818 * and provides methods for traversing, dereferencing, and validating the API.
1919 *
20- * @constructor
21- * @extends $RefParser
20+ * @class
21+ * @augments $RefParser
2222 */
2323function SwaggerParser ( ) {
2424 $RefParser . apply ( this , arguments ) ;
@@ -49,7 +49,7 @@ Object.defineProperty(SwaggerParser.prototype, "api", {
4949 * @param {string } [path] - The file path or URL of the JSON schema
5050 * @param {object } [api] - The Swagger API object. This object will be used instead of reading from `path`.
5151 * @param {ParserOptions } [options] - Options that determine how the API is parsed
52- * @param {function } [callback] - An error-first callback. The second parameter is the parsed API object.
52+ * @param {Function } [callback] - An error-first callback. The second parameter is the parsed API object.
5353 * @returns {Promise } - The returned promise resolves with the parsed API object.
5454 */
5555SwaggerParser . prototype . parse = async function ( path , api , options , callback ) {
@@ -114,7 +114,7 @@ SwaggerParser.prototype.parse = async function (path, api, options, callback) {
114114 * @param {string } [path] - The file path or URL of the JSON schema
115115 * @param {object } [api] - The Swagger API object. This object will be used instead of reading from `path`.
116116 * @param {ParserOptions } [options] - Options that determine how the API is parsed, dereferenced, and validated
117- * @param {function } [callback] - An error-first callback. The second parameter is the parsed API object.
117+ * @param {Function } [callback] - An error-first callback. The second parameter is the parsed API object.
118118 * @returns {Promise } - The returned promise resolves with the parsed API object.
119119 */
120120SwaggerParser . validate = function ( path , api , options , callback ) {
@@ -130,7 +130,7 @@ SwaggerParser.validate = function (path, api, options, callback) {
130130 * @param {string } [path] - The file path or URL of the JSON schema
131131 * @param {object } [api] - The Swagger API object. This object will be used instead of reading from `path`.
132132 * @param {ParserOptions } [options] - Options that determine how the API is parsed, dereferenced, and validated
133- * @param {function } [callback] - An error-first callback. The second parameter is the parsed API object.
133+ * @param {Function } [callback] - An error-first callback. The second parameter is the parsed API object.
134134 * @returns {Promise } - The returned promise resolves with the parsed API object.
135135 */
136136SwaggerParser . prototype . validate = async function ( path , api , options , callback ) {
0 commit comments