Skip to content

Function is missing documentation for parameter undefined with default parameters #194

Open
@jipodine

Description

@jipodine

Hi,

When using an empty object as a default parameter, in a function, a method, or a constructor, I get the following errors, with [email protected] and [email protected]:

jsDoc: Function is missing documentation for parameter `undefined`. at [...]
    30 | * @returns {AudioBuffer}
    31 | */
    32 |export function createDiracBuffer(options = {}) {
jsDoc: Function is missing documentation for parameter `undefined`. at [...]
   140 |   * @returns {Array.<String>} URLs that match every filter.
   141 |   */
   142 |  getUrls(options = {}) {
jsDoc: Function is missing documentation for parameter `undefined`. at [...]
    58 |
    59 |   */
    60 |  constructor(options = {}) {

With the configuration

  "jsDoc": {
    "checkAnnotations": true,
    "checkParamExistence": true,
    "checkParamNames": true,
    "checkRedundantParams": true,
    "checkRedundantReturns": true,
    "checkReturnTypes": true,
    "checkTypes": true,
    "enforceExistence": {
      "allExcept": [
        "arrow",
        "expressions"
      ]
    },
    "requireParamTypes": true,
    "requireReturnTypes": true
  }

And yes, option is defined:

/**
 * Create a Dirac buffer, zero-padded.
 *
 * Warning: the default length is 2 samples,
 * to by-pass a bug in Safari ≤ 9.
 *
 * @param {Object} options
 * @param {AudioContext} options.audioContext must be defined
 * @param {Number} [options.channelCount=1]
 * @param {Number} [options.gain=0] in dB
 * @param {Number} [options.length=2] in samples
 * @returns {AudioBuffer}
 */
export function createDiracBuffer(options = {}) {

Am I missing a configuration somewhere?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions