How to document a ToDo list - jsdoc2md/jsdoc-to-markdown GitHub Wiki

  1. jsdoc2md offers a @done tag to complement the existing jsdoc @todo tag making todo lists possible. For example, this source code:
/**
 * @todo Write the documentation.
 * @todo Implement this function.
 */
function add () {}

/**
 * @todo Write the documentation.
 * @todo Implement this function.
 * @done this one is done
 * @done finished
 */
function subtract () {}

/**
 * @done this one is done
 * @done finished
 */
function multiply () {}

2. Outputs this:

add()

Kind: global function
Todo

  • Write the documentation.
  • Implement this function.

subtract()

Kind: global function
Todo

  • Write the documentation.
  • Implement this function.
  • this one is done
  • finished

multiply()

Kind: global function
Todo

  • this one is done
  • finished