- Further docs

lib/versionmanager.js

@@ -146,10 +146,21 @@ function upgradeDependencies(currentDependencies, latestVersions, options = {})
 
 // Determines if the given version (range) should be upgraded to the latest (i.e. it is valid, it does not currently
 
-// Return true if the version satisfies the range
+/**
+ * Return true if the version satisfies the range.
+ * @type {function}
+ * @param {string} version
+ * @param {string} range
+ * @returns {boolean}
+ */
 const isSatisfied = semver.satisfies;
 
-// satisfy the latest, and it is not beyond the latest)
+/**
+ * Satisfy the latest, and it is not beyond the latest).
+ * @param {string} current
+ * @param {string} latest
+ * @returns {boolean}
+ */
 function isUpgradeable(current, latest) {
 
     // do not upgrade non-npm version declarations (such as git tags)
@@ -228,7 +239,7 @@ function filterAndReject(filter, reject) {
 }
 
 /**
- * Returns an 2-tuple of upgradedDependencies and their latest versions
+ * Returns an 2-tuple of upgradedDependencies and their latest versions.
  * @param {Object} currentDependencies
  * @param {Object} options
  * @returns {Array}
@@ -258,7 +269,7 @@ function upgradePackageDefinitions(currentDependencies, options) {
 }
 
 /**
- * Upgrade the dependency declarations in the package data
+ * Upgrade the dependency declarations in the package data.
  * @param {string} pkgData The package.json data, as utf8 text
  * @param {Object} oldDependencies Old dependencies {package: range}
  * @param {Object} newDependencies New dependencies {package: range}
@@ -300,7 +311,7 @@ async function upgradePackageData(pkgData, oldDependencies, newDependencies, new
 }
 
 /**
- * Get the current dependencies from the package file
+ * Get the current dependencies from the package file.
  * @param {Object} [pkgData={}] Object with dependencies, devDependencies, peerDependencies, optionalDependencies, and/or bundleDependencies properties
  * @param {Object} [options={}]
  * @param {string} options.dep
@@ -356,10 +367,10 @@ function getInstalledPackages(options = {}) {
 }
 
 /**
- * Get the latest or greatest versions from the NPM repository based on the version target
- * @param {Object} packageMap   an object whose keys are package name and values are current versions
- * @param {Object} [options={}]       Options. Default: { versionTarget: 'latest' }. You may also specify { versionTarget: 'greatest' }
- * @returns {Promise<Object>}             Promised {packageName: version} collection
+ * Get the latest or greatest versions from the NPM repository based on the version target.
+ * @param {Object} packageMap   An object whose keys are package name and values are current versions
+ * @param {Object} [options={}] Options. Default: { versionTarget: 'latest' }. You may also specify { versionTarget: 'greatest' }
+ * @returns {Promise<Object>} Promised {packageName: version} collection
  */
 function queryVersions(packageMap, options = {}) {
     let getPackageVersion;
@@ -426,7 +437,7 @@ function queryVersions(packageMap, options = {}) {
     }
 
     /**
-     * Zip up the array of versions into to a nicer object keyed by package name
+     * Zip up the array of versions into to a nicer object keyed by package name.
      * @param {Array} versionList
      * @returns {Object}
      */
@@ -493,6 +504,7 @@ function getVersionTarget(options) {
  * @param {string|Object} packageManagerNameOrObject
  * @param packageManagerNameOrObject.global
  * @param packageManagerNameOrObject.packageManager
+ * @returns {Object}
  */
 function getPackageManager(packageManagerNameOrObject) {