Skip to content

Commit

Permalink
Update JSDoc for pbjs.enableAnalytics (#1565)
Browse files Browse the repository at this point in the history
  • Loading branch information
rmloveland authored and Matt Kendall committed Oct 17, 2017
1 parent 5bfcdc4 commit 1ed7fb5
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions src/prebid.js
Original file line number Diff line number Diff line change
Expand Up @@ -611,8 +611,17 @@ $$PREBID_GLOBAL$$.loadScript = function (tagSrc, callback, useCache) {
};

/**
* Will enable sending a prebid.js to data provider specified
* @param {Object} config object {provider : 'string', options : {}}
* Enable sending analytics data to the analytics provider of your
* choice.
*
* For usage, see [Integrate with the Prebid Analytics
* API](http://prebid.org/dev-docs/integrate-with-the-prebid-analytics-api.html).
*
* For a list of supported analytics adapters, see [Analytics for
* Prebid](http://prebid.org/overview/analytics.html).
* @param {Object} config
* @param {string} config.provider The name of the provider, e.g., `"ga"` for Google Analytics.
* @param {Object} config.options The options for this particular analytics adapter. This will likely vary between adapters.
*/
$$PREBID_GLOBAL$$.enableAnalytics = function (config) {
if (config && !utils.isEmpty(config)) {
Expand Down

0 comments on commit 1ed7fb5

Please sign in to comment.