apidoc/lib/plugins/parser_api_header.js

RESTful web API Documentation Generator

// Same as @apiParam
var apiParam = require("./parser_api_param.js");

function parse(content, source)
{
	return apiParam.parse(content, source, "Header");
}

function pushTo()
{
	return "local.header.fields." + apiParam.getGroup();
}

/**
 * Exports.
 */
module.exports = {
	parse: parse,
	pushTo: pushTo,
	markdownFields: [ "description" ]
};