add jsdoc for project_builder

inner function names are renamed to keep consistency with export names

Change-Id: I9d121b0c440a9dd1d0c0037dca9298ba1dd156c0
This commit is contained in:
Yujun Zhang 2016-07-20 10:24:08 +08:00 committed by Michael Krotscheck
parent df6ee674df
commit 8a5eff7b66
1 changed files with 15 additions and 2 deletions

View File

@ -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
};