From 2788484c4b54265773f8a7705d50675374982cc4 Mon Sep 17 00:00:00 2001 From: zhouyx Date: Tue, 25 Jul 2017 14:54:35 -0700 Subject: [PATCH 1/2] add more description to customEventReporterBuilder class --- src/extension-analytics.js | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/src/extension-analytics.js b/src/extension-analytics.js index 35b1f39ab0d9..177ff739dd81 100644 --- a/src/extension-analytics.js +++ b/src/extension-analytics.js @@ -122,7 +122,9 @@ class CustomEventReporter { /** - * A builder class that enable extension elements to easily build a CustomEventReporter instance + * A builder class that enable extension elements to easily build and get a CustomEventReporter instance. + * Its constructor requires the parent AMP element. + * It provides two methods #track() and #build() to build the CustomEventReporter instance. */ export class CustomEventReporterBuilder { /** @param {!AmpElement} parent */ @@ -141,6 +143,8 @@ export class CustomEventReporterBuilder { /** * @param {string} eventType * @param {string|!Array} request + * The #track() method takes in a unique custom-event name, and the corresponding request (or an array of requests). + * One can call #track() multiple times with different eventType name (order doesn't matter) before #build() is called. */ track(eventType, request) { request = isArray(request) ? request : [request]; @@ -160,8 +164,9 @@ export class CustomEventReporterBuilder { } /** - * Call to build the CustomEventReporter instance. - * Should only be called after all eventType added. + * Call the #build() method to build and get the CustomEventReporter instance. + * One CustomEventReporterBuilder instance can only build one reporter, + * which means #build() should only be called once after all eventType are added. */ build() { dev().assert(this.config_, 'CustomEventReporter already built'); From 6b7985c1964fa9a02532ef2f54a2f7b1ca173c71 Mon Sep 17 00:00:00 2001 From: zhouyx Date: Tue, 25 Jul 2017 15:54:58 -0700 Subject: [PATCH 2/2] address comment --- src/extension-analytics.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/extension-analytics.js b/src/extension-analytics.js index 177ff739dd81..e2adcab3468e 100644 --- a/src/extension-analytics.js +++ b/src/extension-analytics.js @@ -141,10 +141,10 @@ export class CustomEventReporterBuilder { } /** + * The #track() method takes in a unique custom-event name, and the corresponding request url (or an array of request urls). + * One can call #track() multiple times with different eventType name (order doesn't matter) before #build() is called. * @param {string} eventType * @param {string|!Array} request - * The #track() method takes in a unique custom-event name, and the corresponding request (or an array of requests). - * One can call #track() multiple times with different eventType name (order doesn't matter) before #build() is called. */ track(eventType, request) { request = isArray(request) ? request : [request];