7.2.1 • Published 5 years ago
megadoc-plugin-yard-api v7.2.1
YARD-API megadoc Plugin
This plugin parses Rails controllers that are documented in the YARD-API format.
Configuration
See [./lib/config.js]
// megadoc.conf.js
exports['yard-api'] = {
/**
* @property {String}
*
* The full command to use for generating the JSON YARD-API documents.
* This will be run in the repository's root (dir of megadoc.conf.js).
*/
command: "bundle exec rake yard_api",
/**
* @property {String}
*
* Pattern to find the generated JSON documents.
*/
source: "public/doc/api/**/*.json",
/**
* @property {RegExp}
*
* Pattern to exclude any matched JSON source files.
*/
exclude: null,
/**
* @property {Boolean}
*
* TODO: this is currenty dysfunctional.
*/
showEndpointPath: false
};
7.2.1
5 years ago
7.2.0
5 years ago
7.1.1
6 years ago
7.1.0
6 years ago
7.0.0
6 years ago
7.0.0-beta.2
6 years ago
7.0.0-beta.1
6 years ago
5.0.1
8 years ago
5.0.0
8 years ago