Add JSDocs

Author: prashantRaghu

lib/bundle.js

@@ -299,6 +299,7 @@ function handleLocalCollisions(trace, initialMainKeys) {
    * @param {string} commonPathFromData - The common path in the file's paths
    * @param {Array} allData -  array of { path, content} objects
    * @param {object} globalReferences - The accumulated global references from all nodes
+   * @param {function} remoteRefResolver - The function that would be called to fetch remote ref contents
    * @returns {object} - The references in current node and the new content from the node
    */
 async function getReferences (currentNode, isOutOfRoot, pathSolver, parentFilename, version, rootMainKeys,
@@ -334,6 +335,12 @@ async function getReferences (currentNode, isOutOfRoot, pathSolver, parentFilena
 
         remoteRefResolutionPromises.push(
           new Promise(async (resolveInner) => {
+
+            /**
+             * Converts contents received from remoteRefResolver into stringified JSON
+             * @param {string | object} content - contents from remoteRefResolver
+             * @returns Stringified JSON contents
+             */
             function convertToJSONString (content) {
               if (typeof content === 'object') {
                 return JSON.stringify(content);
@@ -534,6 +541,7 @@ async function getReferences (currentNode, isOutOfRoot, pathSolver, parentFilena
    * @param {object} rootMainKeys - A dictionary with the component keys in local components object and its mainKeys
    * @param {string} commonPathFromData - The common path in the file's paths
    * @param {object} globalReferences - The accumulated global refernces from all nodes
+   * @param {function} remoteRefResolver - The function that would be called to fetch remote ref contents
    * @returns {object} - Detect root files result object
    */
 async function getNodeContentAndReferences (currentNode, allData, specRoot, version, rootMainKeys,
@@ -665,6 +673,7 @@ function handleCircularReference(traverseContext, documentContext) {
  * @param {function} refTypeResolver - The resolver function to test if node has a reference
  * @param {object} components - The global components object
  * @param {string} version - The current version
+   * @param {function} remoteRefResolver - The function that would be called to fetch remote ref contents
  * @returns {object} The components object related to the file
  */
 function generateComponentsObject(documentContext, rootContent,
@@ -871,6 +880,7 @@ module.exports = {
    * @param {Array} allData -  array of { path, content} objects
    * @param {Array} origin - process origin (BROWSER or node)
    * @param {string} version - The version we are using
+   * @param {function} remoteRefResolver - The function that would be called to fetch remote ref contents
    * @returns {object} - Detect root files result object
    */
   getBundleContentAndComponents: async function (specRoot, allData, origin, version, remoteRefResolver) {

lib/schemaUtils.js

@@ -5267,6 +5267,7 @@ module.exports = {
    * @param {string} format - the format required by the user
    * @param {boolean} toBundle - if it will be used in bundle
    * @param {object} options - a standard list of options that's globally passed around. Check options.js for more.
+   * @param {function} remoteRefResolver - The function that would be called to fetch remote ref contents
    *
    * @returns {object} root files information and data input
    */