remove unnecessary @function annotations

Surnet · Oct 18, 2020 · 068581a · 068581a
1 parent a19d7e0
commit 068581a
Show file tree

Hide file tree

Showing 10 changed files with 0 additions and 16 deletions.
diff --git a/bin/swagger-jsdoc.js b/bin/swagger-jsdoc.js
@@ -17,7 +17,6 @@ let output = 'swagger.json';
 
 /**
  * Creates a swagger specification from a definition and a set of files.
- * @function
  * @param {object} swaggerDefinition - The swagger definition object.
  * @param {array} apis - List of files to extract documentation from.
  * @param {string} fileName - Name the output file.

diff --git a/lib/helpers/convertGlobPaths.js b/lib/helpers/convertGlobPaths.js
@@ -2,7 +2,6 @@ const glob = require('glob');
 
 /**
  * Converts an array of globs to full paths
- * @function
  * @param {array} globs - Array of globs and/or normal paths
  * @return {array} Array of fully-qualified paths
  * @requires glob

diff --git a/lib/helpers/createSpecification.js b/lib/helpers/createSpecification.js
@@ -3,7 +3,6 @@
 /**
  * Adds necessary properties for a given specification.
  * @see https://goo.gl/Eoagtl
- * @function
  * @param {object} definition - The `definition` or `swaggerDefinition` from options.
  * @returns {object} Object containing required properties of a given specification version.
  */

diff --git a/lib/helpers/filterJsDocComments.js b/lib/helpers/filterJsDocComments.js
@@ -2,7 +2,6 @@ const jsYaml = require('js-yaml');
 
 /**
  * Filters JSDoc comments for those tagged with '@swagger'
- * @function
  * @param {array} jsDocComments - JSDoc comments
  * @returns {array} JSDoc comments tagged with '@swagger'
  * @requires js-yaml

diff --git a/lib/helpers/finalizeSpecificationObject.js b/lib/helpers/finalizeSpecificationObject.js
@@ -4,7 +4,6 @@ const hasEmptyProperty = require('./hasEmptyProperty');
 /**
  * OpenAPI specification validator does not accept empty values for a few properties.
  * Solves validator error: "Schema error should NOT have additional properties"
- * @function
  * @param {object} inputSpec - The swagger/openapi specification
  * @param {object} improvedSpec - The cleaned version of the inputSpec
  */

diff --git a/lib/helpers/hasEmptyProperty.js b/lib/helpers/hasEmptyProperty.js
@@ -1,6 +1,5 @@
 /**
  * Checks if there is any properties of @obj that is a empty object
- * @function
  * @param {object} obj - the object to check
  */
 function hasEmptyProperty(obj) {

diff --git a/lib/helpers/parseApiFile.js b/lib/helpers/parseApiFile.js
@@ -4,7 +4,6 @@ const parseApiFileContent = require('./parseApiFileContent');
 
 /**
  * Parses the provided API file for JSDoc comments.
- * @function
  * @param {string} file - File to be parsed
  * @returns {{jsdoc: array, yaml: array}} JSDoc comments and Yaml files
  */

diff --git a/lib/helpers/parseApiFileContent.js b/lib/helpers/parseApiFileContent.js
@@ -3,8 +3,6 @@ const jsYaml = require('js-yaml');
 
 /**
  * Parse the provided API file content.
- *
- * @function
  * @param {string} fileContent - Content of the file
  * @param {string} ext - File format ('.yaml', '.yml', '.js', etc.)
  * @returns {{jsdoc: array, yaml: array}} JSDoc comments and Yaml files

diff --git a/lib/helpers/specification.js b/lib/helpers/specification.js
@@ -4,7 +4,6 @@
  * Checks if tag is already contained withing target.
  * The tag is an object of type http://swagger.io/specification/#tagObject
  * The target, is the part of the swagger specification that holds all tags.
- * @function
  * @param {object} target - Swagger object place to include the tags data.
  * @param {object} tag - Swagger tag object to be included.
  * @returns {boolean} Does tag is already present in target
@@ -28,7 +27,6 @@ function tagDuplicated(target, tag) {
 
 /**
  * Adds the tags property to a swagger object.
- * @function
  * @param {object} conf - Flexible configuration.
  */
 function attachTags(conf) {
@@ -52,7 +50,6 @@ function attachTags(conf) {
 
 /**
  * List of deprecated or wrong swagger schema properties in singular.
- * @function
  * @returns {array} The list of deprecated property names.
  */
 function getSwaggerSchemaWrongProperties() {
@@ -71,7 +68,6 @@ function getSwaggerSchemaWrongProperties() {
 
 /**
  * Makes a deprecated property plural if necessary.
- * @function
  * @param {string} propertyName - The swagger property name to check.
  * @returns {string} The updated propertyName if neccessary.
  */
@@ -86,7 +82,6 @@ function correctSwaggerKey(propertyName) {
 
 /**
  * Handles swagger propertyName in pathObject context for swaggerObject.
- * @function
  * @param {object} swaggerObject - The swagger object to update.
  * @param {object} pathObject - The input context of an item for swaggerObject.
  * @param {string} propertyName - The property to handle.
@@ -145,7 +140,6 @@ function organizeSwaggerProperties(swaggerObject, pathObject, propertyName) {
 
 /**
  * Adds the data in to the swagger object.
- * @function
  * @param {object} swaggerObject - Swagger object which will be written to
  * @param {object[]} data - objects of parsed swagger data from yml or jsDoc
  *                          comments

diff --git a/lib/index.js b/lib/index.js
@@ -7,7 +7,6 @@ const finalizeSpecificationObject = require('./helpers/finalizeSpecificationObje
 
 /**
  * Generates the specification.
- * @function
  * @param {object} options - Configuration options
  * @returns {object} Output specification
  * @requires swagger-parser