From 8a5eff7b66c24685133cc2d26e6b2a30876fb9b9 Mon Sep 17 00:00:00 2001 From: Yujun Zhang Date: Wed, 20 Jul 2016 10:24:08 +0800 Subject: [PATCH] add jsdoc for project_builder inner function names are renamed to keep consistency with export names Change-Id: I9d121b0c440a9dd1d0c0037dca9298ba1dd156c0 --- generators/app/lib/project_builder.js | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/generators/app/lib/project_builder.js b/generators/app/lib/project_builder.js index 92e9cea..941a63a 100644 --- a/generators/app/lib/project_builder.js +++ b/generators/app/lib/project_builder.js @@ -14,6 +14,11 @@ * under the License. */ +/** + * Project builder module + * @module + */ + 'use strict'; var includedFiles = []; @@ -98,19 +103,27 @@ function getIgnoredFiles () { * * @returns {void} */ -function clearAll () { +function clear () { includedFiles = []; excludedFiles = []; ignoredFiles = []; } module.exports = { + /** @see {@link module:project_builder~addFile} */ addFile: addFile, + /** @see {@link module:project_builder~writeFile} */ writeFile: writeFile, + /** @see {@link module:project_builder~removeFile} */ removeFile: removeFile, + /** @see {@link module:project_builder~ignoreFile} */ ignoreFile: ignoreFile, + /** @see {@link module:project_builder~getIncludedFiles} */ getIncludedFiles: getIncludedFiles, + /** @see {@link module:project_builder~getIgnoredFiles} */ getIgnoredFiles: getIgnoredFiles, + /** @see {@link module:project_builder~getExcludedFiles} */ getExcludedFiles: getExcludedFiles, - clear: clearAll + /** @see {@link module:project_builder~clear} */ + clear: clear };