This marks an object as being a function, even though it may not appear to be one to the parser. It sets the doclet's @kind to 'function'.
/** @function */ var paginate = paginateFactory(pages);
Without the @function tag, the
paginate object would be documented as a generic object (a @member), because it isn't possible to tell from examining the line of code what type of value
paginate will hold when it is run.
/** @function myFunction */ // the above is the same as: /** @function * @name myFunction */
© 2011–2017 the contributors to the JSDoc 3 documentation project
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.