From e3bbe6840a238c8ef570f93a1053ccef758d4914 Mon Sep 17 00:00:00 2001
From: Yujun Zhang <zhang.yujunz@zte.com.cn>
Date: Fri, 22 Jul 2016 11:08:46 +0800
Subject: [PATCH] add jsdoc to component/nsp

Change-Id: I339b519db3f61b0d44d83c69316ee673fa0e7c46
---
 generators/app/lib/component/nsp.js | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/generators/app/lib/component/nsp.js b/generators/app/lib/component/nsp.js
index ef60c80..7543b14 100644
--- a/generators/app/lib/component/nsp.js
+++ b/generators/app/lib/component/nsp.js
@@ -18,6 +18,7 @@
  * This module adds the Node Security commandline tool (nsp) to the project.
  * Its job is to identify known vulnerabilities by scanning the projects
  * source and dependencies.
+ * @module
  */
 
 'use strict';
@@ -42,7 +43,7 @@ function noop (generator) {
  * @param {generator} generator The currently active generator.
  * @returns {generator} The passed generator, for promise chaining.
  */
-function promptNsp (generator) {
+function prompt (generator) {
   // At this time, we don't actually need to prompt the user.
 
   // Add the dependencies.
@@ -58,13 +59,16 @@ function promptNsp (generator) {
  * @param {generator} generator The currently active generator.
  * @returns {generator} The passed generator, for promise chaining.
  */
-function configureNsp (generator) {
+function configure (generator) {
   projectBuilder.addFile('.nsprc');
   return generator;
 }
 
 module.exports = {
+  /** @see {@link module:component/nsp~noop} */
   init: noop,
-  prompt: promptNsp,
-  configure: configureNsp
+  /** @see {@link module:component/nsp~prompt} */
+  prompt: prompt,
+  /** @see {@link module:component/nsp~configure} */
+  configure: configure
 };