Skip to content

Commit 25ecb1f

Browse files
committed
♻️ JSDoc module updates fixing compile error
- Updated and refactored JSDoc comments in the aModule.js file. - Removed non-standard tags and standardized module documentation. - Improved code documentation and clarity.
1 parent 019d526 commit 25ecb1f

3 files changed

Lines changed: 10 additions & 12 deletions

File tree

src/FileCabinet/SuiteScripts/CS/customModule_CS.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
(() => {
1414
/**
1515
* @name Dependencies
16-
* @memberof module:csExampleModule_CS
16+
* @memberof module:/SuiteScripts/CS/csExampleModule_CS
1717
* @type {Array}
1818
* @description Array of dependencies the client script module requires
1919
* @ignore
@@ -41,7 +41,7 @@
4141
})();
4242

4343
/**
44-
* @alias module:csExampleModule_CS
44+
* @alias module:/SuiteScripts/CS/csExampleModule_CS
4545
* @description Custom NetSuite Client Script module export function
4646
* @param {Object} log - NS log module
4747
* @param {Object} aModule - Custom NetSuite module A
@@ -50,7 +50,7 @@
5050
function csExampleModule_CS(log, aModule, bModule) {
5151
/**
5252
* @name pageInit
53-
* @memberof module:csExampleModule_CS
53+
* @memberof module:/SuiteScripts/CS/csExampleModule_CS
5454
* @function
5555
* @param {Object} scriptContext - Passed parameter for NetSuite CS pageInit entry function
5656
* @param {Record} scriptContext.currentRecord - Current form record
@@ -76,7 +76,7 @@ function csExampleModule_CS(log, aModule, bModule) {
7676
};
7777
/**
7878
* @name saveRecord
79-
* @memberof module:csExampleModule_CS
79+
* @memberof module:/SuiteScripts/CS/csExampleModule_CS
8080
* @function
8181
* @param {Object} scriptContext -- Passed parameter for NetSuite CS saveRecord entry function
8282
* @param {Object} scriptContext.currentRecord -- Current record being saved

src/FileCabinet/SuiteScripts/Modules/aModule.js

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
/**
22
* @format
33
* @module aModule
4-
* @description Your custom NetSuite module A
54
* @version 1.0.0
65
* @NApiVersion 2.1
76
* @preserve NApiVersion
87
* @since 2022.2
9-
* @summary This is example custom NetSuite module A. It may or may not be in your SuiteCloud project.
8+
* @description This is example custom NetSuite module A. It may or may not be in your SuiteCloud project.
109
* Update your `jest.config.js` to map this module from the stub pkg to your local project if it is available.
1110
* See project `jest.config.js` for further examples of this.
1211
*/
1312
(() => {
1413
/**
1514
* @name Dependencies
16-
* @memberof module:aModule
15+
* @memberof module:/SuiteScripts/Modules/aModule
1716
* @type {Array}
1817
* @description Array of dependencies the module requires
1918
* @ignore
@@ -37,7 +36,7 @@
3736
})();
3837

3938
/**
40-
* @alias module:aModule
39+
* @module module:/SuiteScripts/Modules/aModule
4140
* @description NetSuite module A export function
4241
* @param {Object} query - NS query module
4342
* @param {Object} log - NS log module
@@ -47,7 +46,7 @@ function aModule(query, log) {
4746
* @name GetVendorPrefix
4847
* @description Returns preferred vendor prefix from record or blank if no prefix is located
4948
* @function
50-
* @memberof module:aModule
49+
* @memberof module:/SuiteScripts/Modules/aModule
5150
* @param {String} vendorId - Entity ID of vendor Ex: `4321`
5251
* @return {String}
5352
*/ const GetVendorPrefix = vendorId => {
@@ -57,7 +56,7 @@ function aModule(query, log) {
5756
};
5857
/**
5958
* @name RunQuery
60-
* @memberof module:aModule
59+
* @memberof module:/SuiteScripts/Modules/aModule
6160
* @description Returns query result of vendor prefix from vendor record
6261
* @function
6362
* @protected

src/FileCabinet/SuiteScripts/Modules/aModule.min.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
/**
22
* @format
33
* @module aModule
4-
* @description Your custom NetSuite module A
54
* @version 1.0.0
65
* @NApiVersion 2.1
76
* @preserve NApiVersion
87
* @since 2022.2
9-
* @summary This is example custom NetSuite module A. It may or may not be in your SuiteCloud project.
8+
* @description This is example custom NetSuite module A. It may or may not be in your SuiteCloud project.
109
* Update your `jest.config.js` to map this module from the stub pkg to your local project if it is available.
1110
* See project `jest.config.js` for further examples of this.
1211
*/

0 commit comments

Comments
 (0)