Update comments

Author: yavorona

packages/optimizely-sdk/lib/core/event_builder/event_helpers.js

@@ -25,15 +25,15 @@ var logger = getLogger('EVENT_BUILDER');
 
 /**
  * Creates an ImpressionEvent object from decision data
- * @param {Object} config
- * @param {Object} config.decisionObj
- * @param {String} config.userId
- * @param {String} config.flagKey
- * @param {boolean} config.enabled
- * @param {Object} config.userAttributes
- * @param {String} config.clientEngine
- * @param {String} config.clientVersion
- * @return {Object} an ImpressionEvent object
+ * @param  {Object}  config
+ * @param  {Object}  config.decisionObj
+ * @param  {String}  config.userId
+ * @param  {String}  config.flagKey
+ * @param  {boolean} config.enabled
+ * @param  {Object}  config.userAttributes
+ * @param  {String}  config.clientEngine
+ * @param  {String}  config.clientVersion
+ * @return {Object}  an ImpressionEvent object
  */
 export var buildImpressionEvent = function(config) {
   var configObj = config.configObj;

packages/optimizely-sdk/lib/core/event_builder/index.js

@@ -90,13 +90,14 @@ function getCommonEventParams(options) {
 
 /**
  * Creates object of params specific to impression events
- * @param  {Object} configObj    Object representing project configuration
- * @param  {string} experimentId ID of experiment for which impression needs to be recorded
- * @param  {string} variationId  ID for variation which would be presented to user
- * @param  {string} ruleKey      Key of experiment for which impression needs to be recorded
- * @param  {string} ruleType     Type for the decision source
- * @param  {string} flagKey      Key for a feature flag
- * @return {Object}              Impression event params
+ * @param  {Object}  configObj    Object representing project configuration
+ * @param  {string}  experimentId ID of experiment for which impression needs to be recorded
+ * @param  {string}  variationId  ID for variation which would be presented to user
+ * @param  {string}  ruleKey      Key of experiment for which impression needs to be recorded
+ * @param  {string}  ruleType     Type for the decision source
+ * @param  {string}  flagKey      Key for a feature flag
+ * @param  {boolean} enabled      Boolean representing if feature is enabled
+ * @return {Object}               Impression event params
  */
 function getImpressionEventParams(configObj, experimentId, variationId, ruleKey, ruleType, flagKey, enabled) {
   let campaignId = null;
@@ -177,19 +178,19 @@ function getVisitorSnapshot(configObj, eventKey, eventTags, logger) {
 
 /**
  * Create impression event params to be sent to the logging endpoint
- * @param  {Object} options               Object containing values needed to build impression event
- * @param  {Object} options.attributes    Object representing user attributes and values which need to be recorded
- * @param  {string} options.clientEngine  The client we are using: node or javascript
- * @param  {string} options.clientVersion The version of the client
- * @param  {Object} options.configObj     Object representing project configuration, including datafile information and mappings for quick lookup
- * @param  {string} options.experimentId  Experiment for which impression needs to be recorded
- * @param  {string} options.userId        ID for user
- * @param  {string} options.variationId   ID for variation which would be presented to user
- * @param  {string} options.ruleKey       Key of an experiment for which impression needs to be recorded
- * @param  {string} options.ruleType      Type for the decision source
- * @param  {string} options.flagKey       Key for a feature flag
- * @param  {string} options.enabled       Boolean enabled for a feature
- * @return {Object}                       Params to be used in impression event logging endpoint call
+ * @param  {Object}  options               Object containing values needed to build impression event
+ * @param  {Object}  options.attributes    Object representing user attributes and values which need to be recorded
+ * @param  {string}  options.clientEngine  The client we are using: node or javascript
+ * @param  {string}  options.clientVersion The version of the client
+ * @param  {Object}  options.configObj     Object representing project configuration, including datafile information and mappings for quick lookup
+ * @param  {string}  options.experimentId  Experiment for which impression needs to be recorded
+ * @param  {string}  options.userId        ID for user
+ * @param  {string}  options.variationId   ID for variation which would be presented to user
+ * @param  {string}  options.ruleKey       Key of an experiment for which impression needs to be recorded
+ * @param  {string}  options.ruleType      Type for the decision source
+ * @param  {string}  options.flagKey       Key for a feature flag
+ * @param  {boolean} options.enabled       Boolean representing if feature is enabled
+ * @return {Object}                        Params to be used in impression event logging endpoint call
  */
 export var getImpressionEvent = function(options) {
   var impressionEvent = {

packages/optimizely-sdk/lib/optimizely/index.ts

@@ -280,6 +280,7 @@ export default class Optimizely {
    * @param {string}         flagKey        Key for a feature flag
    * @param {string}         userId         ID of user to whom the variation was shown
    * @param {UserAttributes} attributes     Optional user attributes
+   * @param {boolean}        enabled        Boolean representing if feature is enabled
    */
   private sendImpressionEvent(
     decisionObj: DecisionObj,
@@ -313,6 +314,7 @@ export default class Optimizely {
    * @param  {DecisionObj}    decisionObj    Decision object
    * @param  {string}         flagKey        Key for a feature flag
    * @param  {string}         userId         ID of user to whom the variation was shown
+   * @param  {boolean}        enabled        Boolean representing if feature is enabled
    * @param  {UserAttributes} attributes     Optional user attributes
    */
   private emitNotificationCenterActivate(