x
/
js-generator-openstack
Code Issues Proposed changes

Merge "add jsdoc to component/gitignore"

This commit is contained in:
Jenkins 2016-07-22 17:39:23 +00:00 committed by Gerrit Code Review
parent 8a7b536bb6 a747ec2722
commit 934e70c335
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
generators/app/lib/component/gitignore.js
View File

@ -14,6 +14,11 @@
* under the License.
*/
/**
* gitignore module
* @module
*/
'use strict';
var projectBuilder = require('../project_builder');
@ -37,7 +42,7 @@ function noop (generator) {
* @param {generator} generator The currently active generator.
* @returns {generator} The passed generator, for promise chaining.
*/
function initGitignore (generator) {
function init (generator) {
var fs = generator.fs;
// Reinitialize the ignore map.
@ -67,7 +72,7 @@ function initGitignore (generator) {
* @param {generator} generator The currently active generator.
* @returns {generator} The passed generator, for promise chaining.
*/
function configureGitIgnore (generator) {
function configure (generator) {
var ignoreContent = buildGitignore();
if (ignoreContent.length === 0) {
// Delete the file if there's nothing to ignore.
@ -97,7 +102,10 @@ function buildGitignore () {
}
module.exports = {
init: initGitignore,
/** @see {@link module:component/gitignore~init} */
init: init,
/** @see {@link module:component/gitignore~noop} */
prompt: noop,
configure: configureGitIgnore
/** @see {@link module:component/gitignore~configure} */
configure: configure
};