Function outJsDoc

bin/api-docs.js:42–63

(tag, params, paramNames)

}

function outJsDoc(tag, params, paramNames) {
  for(const name in params) {
    const typedef = normalize(params[name])

    // console.error('outJsDoc', tag, typedef, paramNames);

    const paramName = name.replace(/\[\]$/, '')
    const paramNameDefault = typedef.default == null ?
      paramName : `${paramName} = ${typedef.default}`

    const paramNameDefaultRequired =
      typedef.optional || typedef.default != null ?
        `[${paramNameDefault}]` : paramNameDefault

    const doc = typedef.doc ? ` - ${typedef.doc.trim()}` : ''
    const typeName = typedef.type
    out(`${tag} {${typeName}} ${paramNameDefaultRequired}${doc}`)
    if(paramNames) {
      paramNames.push(paramName)
    }
  }
}

outln('// Generated file, see bin/api-docs.js')