x/js-generator-openstack
Code Issues Proposed changes

Merge "add jsdoc to component/gerrit"

Browse Source
This commit is contained in:
Jenkins
2016-07-22 17:39:29 +00:00
committed by Gerrit Code Review
parent 934e70c335 5f020788d6
commit d335e609a2
1 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
generators/app/lib/component/gerrit.js
View File

@@ -14,6 +14,11 @@
* under the License. * under the License.
*/ */
/**
* gerrit module
* @module
*/
'use strict'; 'use strict';
var projectBuilder = require('../project_builder'); var projectBuilder = require('../project_builder');
@@ -42,7 +47,7 @@ var gerritEnabled = function(answers) {
* @param {generator} generator The currently active generator. * @param {generator} generator The currently active generator.
* @returns {generator} The passed generator, for promise chaining. * @returns {generator} The passed generator, for promise chaining.
*/ */
function initializeGerrit (generator) { function init (generator) {
// Define our defaults // Define our defaults
iniContent = { iniContent = {
gerrit: { gerrit: {
@@ -61,7 +66,7 @@ function initializeGerrit (generator) {
* @param {generator} generator The currently active generator. * @param {generator} generator The currently active generator.
* @returns {generator} The passed generator, for promise chaining. * @returns {generator} The passed generator, for promise chaining.
*/ */
function promptUserOptions (generator) { function prompt (generator) {
// Read the existing file and populate it as defaults. // Read the existing file and populate it as defaults.
if (generator.fs.exists(gerritFile)) { if (generator.fs.exists(gerritFile)) {
@@ -123,7 +128,7 @@ function promptUserOptions (generator) {
* @param {generator} generator The currently active generator. * @param {generator} generator The currently active generator.
* @returns {generator} The passed generator, for promise chaining. * @returns {generator} The passed generator, for promise chaining.
*/ */
function configureGerrit (generator) { function configure (generator) {
if (gerritFileExists) { if (gerritFileExists) {
projectBuilder.writeFile(gerritFile, buildGerritFile); projectBuilder.writeFile(gerritFile, buildGerritFile);
} else { } else {
@@ -138,7 +143,10 @@ function buildGerritFile () {
} }
module.exports = { module.exports = {
init: initializeGerrit, /** @see {@link module:component/gerrit~init} */
prompt: promptUserOptions, init: init,
configure: configureGerrit /** @see {@link module:component/gerrit~prompt} */
prompt: prompt,
/** @see {@link module:component/gerrit~configure} */
configure: configure
}; };