From dc83664603e3aaa270e41583bedf6c462f485be4 Mon Sep 17 00:00:00 2001 From: Yujun Zhang Date: Fri, 22 Jul 2016 11:03:34 +0800 Subject: [PATCH] add jsdoc to component/license Change-Id: Ic489aa50f806e1a14630d4948bc9b3a6b346d8b5 --- generators/app/lib/component/license.js | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/generators/app/lib/component/license.js b/generators/app/lib/component/license.js index 4c33a5c..79fedb7 100644 --- a/generators/app/lib/component/license.js +++ b/generators/app/lib/component/license.js @@ -14,6 +14,11 @@ * under the License. */ +/** + * licence module + * @module + */ + 'use strict'; var projectBuilder = require('../project_builder'); @@ -35,7 +40,7 @@ function noop (generator) { * @param {generator} generator The currently active generator. * @returns {generator} The passed generator, for promise chaining. */ -function configureLicense (generator) { +function configure (generator) { projectBuilder.addFile('LICENSE'); pkgBuilder.setValues({license: 'Apache-2.0'}); @@ -43,7 +48,10 @@ function configureLicense (generator) { } module.exports = { + /** @see {@link module:component/license~noop} */ init: noop, + /** @see {@link module:component/license~noop} */ prompt: noop, - configure: configureLicense + /** @see {@link module:component/license~configure} */ + configure: configure };