GPII-228 Minor refactoring of promise chains, documenting invokers

Author: sgithens

gpii/node_modules/flowManager/src/Capture.js

@@ -45,8 +45,8 @@ fluid.defaults("gpii.flowManager.capture", {
             priority: "first"
         },
         "onCaptureSettingsForCurrentDevice.captureSystemSettings": {
-            func: "{that}.captureSystemSettings",
-            args: ["{arguments}.0", "{arguments}.1"],
+            funcName: "gpii.flowManager.capture.captureSystemSettings",
+            args: ["{lifecycleManager}.read", "{arguments}.0", "{arguments}.1"], // solutionsRegistryEntries, options
             priority: "after:getInstalledSolutionsForCurrentDevice"
         },
         "onCaptureSettingsForCurrentDevice.formatRawCapturedSettings": {
@@ -62,26 +62,34 @@ fluid.defaults("gpii.flowManager.capture", {
         },
         getSystemSettingsCapture: {
             funcName: "fluid.promise.fireTransformEvent",
-            args: ["{that}.events.onCaptureSettingsForCurrentDevice", {}, "{arguments}.0"] // options
-        },
-        captureSystemSettings: {
-            funcName: "gpii.flowManager.capture.captureSystemSettings",
-            args: ["{lifecycleManager}.read", "{arguments}.0", "{arguments}.1"] // solutionsRegistryEntries, options
+            args: ["{that}.events.onCaptureSettingsForCurrentDevice", null, "{arguments}.0"] // options
         }
     }
 });
 
+/**
+ * Invoker `{gpii.flowManager.capture}.getInstalledSolutionsForCurrentDevice`
+ *
+ * @method
+ * @name {gpii.flowManager.capture}.getInstalledSolutionsForCurrentDevice
+ *
+ * This invoker method will return the solution registry entries, in their usual json format,
+ * that are available on the current device.
+ *
+ * @return {Promise} A promise resolved with an object of solutions registry entries available on the
+ * current device. As with the solutions registry itself, these are keyed by the solution ID.
+ */
+
 /**
  * Invoker `{gpii.flowManager.capture}.getSystemSettingsCapture`
  *
- * @function
+ * @method
  * @name {gpii.flowManager.capture}.getSystemSettingsCapture
  *
  * This main API entry point for capturing settings from a system or computer. This captures
  * the actual settings on the device, so it assumed to be running in a local untrusted flow
  * manager.
  *
- * @param {Event} onCaptureSettingsForCurrentDevice - The transforming promise chain
  * @param {Object} options - Options for this chain.
  * @param {Array} options.solutionsList - An array of solution IDs to filter by when
  * retreiving settings. If this option is not included, all available settings will be
@@ -183,7 +191,7 @@ gpii.flowManager.capture.formatRawCapturedSettings = function (data) {
             if (!togo[key]) {
                 togo[key] = {};
             }
-            fluid.each(fluid.get(item, "0.settings"), function (value, settingId) {
+            fluid.each(fluid.get(item, [0, "settings"]), function (value, settingId) {
                 togo[key][settingId] = value;
             });
         });