How to document an ES2015 module (multiple named exports) - jsdoc2md/jsdoc-to-markdown GitHub Wiki

1. Say you have a ES2015 module you'd like to document.

export const pi = 3.14

export function add (a, b) {
  return a + b
}

export function subtract (a, b) {
  return a - b
}

2. Given that jsdoc2md only generates markdown for documented identifiers and modules, you must document each identifier you want to appear in output - including the module. Therefore, you must use @module at the top of the file to document the module.

/**
 * @module maths
 */

/**
 * exported number
 */
export const pi = 3.14

/**
 * Add two values.
 */
export function add (a, b) {
  return a + b
}

/**
 * Subtraction.
 */
export function subtract (a, b) {
  return a - b
}

3. This file will now appear in jsdoc2md output (without the @module tag it will not appear):

• maths
  • .pi
  • .add()
  • .subtract()

exported number

Kind: static constant of maths

Add two values.

Kind: static method of maths

Subtraction.

Kind: static method of maths