x
/
js-generator-openstack
Code Issues Proposed changes

add jsdoc to component/pkg 

Change-Id: Ieaa41958478e1c15e46d93d982a93cf42d4b4f78
This commit is contained in:
Yujun Zhang 2016-07-22 11:11:18 +08:00
parent 57029cdeb1
commit cab1fcfa3e
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -14,6 +14,11 @@
* under the License. * under the License.
*/ */
/**
* package module
* @module
*/
'use strict'; 'use strict';
var Q = require('q'); var Q = require('q');
@ -30,7 +35,7 @@ var packagePath = 'package.json';
* @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 promptPackage (generator) { function prompt (generator) {
var deferred = Q.defer(); var deferred = Q.defer();
if (!generator.options['non-interactive']) { if (!generator.options['non-interactive']) {
@ -79,7 +84,7 @@ function promptPackage (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 initializePackage (generator) { function init (generator) {
var fs = generator.fs; var fs = generator.fs;
// Read package.json // Read package.json
@ -109,13 +114,16 @@ function initializePackage (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 configurePkg (generator) { function configure (generator) {
projectBuilder.writeFile('package.json', pkgBuilder.toJSON); projectBuilder.writeFile('package.json', pkgBuilder.toJSON);
return generator; return generator;
} }
module.exports = { module.exports = {
init: initializePackage, /** @see {@link module:component/pkg~init} */
prompt: promptPackage, init: init,
configure: configurePkg /** @see {@link module:component/pkg~prompt} */
prompt: prompt,
/** @see {@link module:component/pkg~configure} */
configure: configure
}; };