From 1ed7fb55f0353739b46a53d340e7eed49879f54c Mon Sep 17 00:00:00 2001 From: Rich Loveland Date: Tue, 17 Oct 2017 11:31:30 -0400 Subject: [PATCH] Update JSDoc for `pbjs.enableAnalytics` (#1565) --- src/prebid.js | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/src/prebid.js b/src/prebid.js index 4aeb5482100..5e3168a829d 100644 --- a/src/prebid.js +++ b/src/prebid.js @@ -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)) {