apidoc-light/lib/core/parsers/api_body.js

RESTful web API Documentation Generator

// Same as @apiParam
const apiParser = require('./api_param.js');

function parse (content, source) {
  const result = apiParser.parse(content, source, 'Body');
  // for checkboxes the html will look at the checked property for setting the checked
  // state of the box, not the defaultValue
  if (typeof result.type === 'string' && result.type.toLowerCase() === 'boolean') {
    result.checked = Boolean(result.defaultValue);
  }
  return result;
}

/**
 * Exports
 */
module.exports = {
  parse: parse,
  path: 'local.body',
  method: apiParser.method,
  markdownFields: ['description'],
};