Applying documentation updates.

github-actions[bot] · github-actions[bot] · commit 77829ae8a845 · 2021-08-04T10:16:36.000Z
diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browserplugin.activatebrowserplugin.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browserplugin.activatebrowserplugin.md
@@ -6,10 +6,13 @@
 
 Called when the plugin is initialised during the Tracker construction
 
-Use to capture the specific Tracker instance for each instance of a Browser Plugin
-
 <b>Signature:</b>
 
 ```typescript
 activateBrowserPlugin?: (tracker: BrowserTracker) => void;
 ```
+
+## Remarks
+
+Use to capture the specific Tracker instance for each instance of a Browser Plugin
+
diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browserplugin.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browserplugin.md
@@ -17,5 +17,5 @@ interface BrowserPlugin extends CorePlugin
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [activateBrowserPlugin?](./browser-tracker.browserplugin.activatebrowserplugin.md) | (tracker: BrowserTracker) =&gt; void | <i>(Optional)</i> Called when the plugin is initialised during the Tracker construction<!-- -->Use to capture the specific Tracker instance for each instance of a Browser Plugin |
+|  [activateBrowserPlugin?](./browser-tracker.browserplugin.activatebrowserplugin.md) | (tracker: BrowserTracker) =&gt; void | <i>(Optional)</i> Called when the plugin is initialised during the Tracker construction |
 
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.md b/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.md
@@ -6,14 +6,16 @@
 
 An Ad Click Event Used to track an advertisement click
 
- If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
-
 <b>Signature:</b>
 
 ```typescript
 interface AdClickEvent 
 ```
 
+## Remarks
+
+If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
+
 ## Properties
 
 |  Property | Type | Description |
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.md b/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.md
@@ -6,14 +6,16 @@
 
 An Ad Conversion Event Used to track an advertisement click
 
- If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
-
 <b>Signature:</b>
 
 ```typescript
 interface AdConversionEvent 
 ```
 
+## Remarks
+
+If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
+
 ## Properties
 
 |  Property | Type | Description |
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.md b/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.md
@@ -6,14 +6,16 @@
 
 An Ad Impression Event Used to track an advertisement impression
 
- If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
-
 <b>Signature:</b>
 
 ```typescript
 interface AdImpressionEvent 
 ```
 
+## Remarks
+
+If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
+
 ## Properties
 
 |  Property | Type | Description |
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildadclick.md b/trackers/node-tracker/docs/markdown/node-tracker.buildadclick.md
@@ -6,8 +6,6 @@
 
 Build a Ad Click Event Used to track an advertisement click
 
- If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
-
 <b>Signature:</b>
 
 ```typescript
@@ -18,9 +16,15 @@ declare function buildAdClick(event: AdClickEvent): PayloadBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | AdClickEvent | Contains the properties for the Ad Click event  PayloadBuilder to be sent to  |
+|  event | AdClickEvent | Contains the properties for the Ad Click event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
+## Remarks
+
+If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildadconversion.md b/trackers/node-tracker/docs/markdown/node-tracker.buildadconversion.md
@@ -6,8 +6,6 @@
 
 Build a Ad Conversion Event Used to track an advertisement click
 
- If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
-
 <b>Signature:</b>
 
 ```typescript
@@ -18,9 +16,15 @@ declare function buildAdConversion(event: AdConversionEvent): PayloadBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | AdConversionEvent | Contains the properties for the Ad Conversion event  PayloadBuilder to be sent to  |
+|  event | AdConversionEvent | Contains the properties for the Ad Conversion event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
+## Remarks
+
+If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildaddtocart.md b/trackers/node-tracker/docs/markdown/node-tracker.buildaddtocart.md
@@ -16,9 +16,11 @@ declare function buildAddToCart(event: AddToCartEvent): PayloadBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | AddToCartEvent | Contains the properties for the Add To Cart event  PayloadBuilder to be sent to  |
+|  event | AddToCartEvent | Contains the properties for the Add To Cart event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildadimpression.md b/trackers/node-tracker/docs/markdown/node-tracker.buildadimpression.md
@@ -6,8 +6,6 @@
 
 Build a Ad Impression Event Used to track an advertisement impression
 
- If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
-
 <b>Signature:</b>
 
 ```typescript
@@ -18,9 +16,15 @@ declare function buildAdImpression(event: AdImpressionEvent): PayloadBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | AdImpressionEvent | Contains the properties for the Ad Impression event  PayloadBuilder to be sent to  |
+|  event | AdImpressionEvent | Contains the properties for the Ad Impression event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
+## Remarks
+
+If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildconsentgranted.md b/trackers/node-tracker/docs/markdown/node-tracker.buildconsentgranted.md
@@ -22,9 +22,11 @@ declare function buildConsentGranted(event: ConsentGrantedEvent): {
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | ConsentGrantedEvent | Contains the properties for the Consent Granted event  An object containing the PayloadBuilder to be sent to  and a 'consent\_document' context |
+|  event | ConsentGrantedEvent | Contains the properties for the Consent Granted event |
 
 <b>Returns:</b>
 
 { event: PayloadBuilder; context: { schema: string; data: Record&lt;string, unknown&gt;; }\[\]; }
 
+An object containing the PayloadBuilder to be sent to  and a 'consent\_document' context
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildconsentwithdrawn.md b/trackers/node-tracker/docs/markdown/node-tracker.buildconsentwithdrawn.md
@@ -22,9 +22,11 @@ declare function buildConsentWithdrawn(event: ConsentWithdrawnEvent): {
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | ConsentWithdrawnEvent | Contains the properties for the Consent Withdrawn event  An object containing the PayloadBuilder to be sent to  and a 'consent\_document' context |
+|  event | ConsentWithdrawnEvent | Contains the properties for the Consent Withdrawn event |
 
 <b>Returns:</b>
 
 { event: PayloadBuilder; context: { schema: string; data: Record&lt;string, unknown&gt;; }\[\]; }
 
+An object containing the PayloadBuilder to be sent to  and a 'consent\_document' context
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildecommercetransaction.md b/trackers/node-tracker/docs/markdown/node-tracker.buildecommercetransaction.md
@@ -16,9 +16,11 @@ declare function buildEcommerceTransaction(event: EcommerceTransactionEvent): Pa
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | EcommerceTransactionEvent | Contains the properties for the Ecommerce Transactoion event  PayloadBuilder to be sent to  |
+|  event | EcommerceTransactionEvent | Contains the properties for the Ecommerce Transactoion event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildecommercetransactionitem.md b/trackers/node-tracker/docs/markdown/node-tracker.buildecommercetransactionitem.md
@@ -16,9 +16,11 @@ declare function buildEcommerceTransactionItem(event: EcommerceTransactionItemEv
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | EcommerceTransactionItemEvent | Contains the properties for the Ecommerce Transaction Item event  PayloadBuilder to be sent to  |
+|  event | EcommerceTransactionItemEvent | Contains the properties for the Ecommerce Transaction Item event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildformfocusorchange.md b/trackers/node-tracker/docs/markdown/node-tracker.buildformfocusorchange.md
@@ -16,9 +16,11 @@ declare function buildFormFocusOrChange(event: FormFocusOrChangeEvent): PayloadB
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | FormFocusOrChangeEvent | Contains the properties for the Form Focus or Change Form event  PayloadBuilder to be sent to  |
+|  event | FormFocusOrChangeEvent | Contains the properties for the Form Focus or Change Form event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildformsubmission.md b/trackers/node-tracker/docs/markdown/node-tracker.buildformsubmission.md
@@ -16,9 +16,11 @@ declare function buildFormSubmission(event: FormSubmissionEvent): PayloadBuilder
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | FormSubmissionEvent | Contains the properties for the Form Submission event  PayloadBuilder to be sent to  |
+|  event | FormSubmissionEvent | Contains the properties for the Form Submission event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildlinkclick.md b/trackers/node-tracker/docs/markdown/node-tracker.buildlinkclick.md
@@ -16,9 +16,11 @@ declare function buildLinkClick(event: LinkClickEvent): PayloadBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | LinkClickEvent | Contains the properties for the Link Click event  PayloadBuilder to be sent to  |
+|  event | LinkClickEvent | Contains the properties for the Link Click event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildpageping.md b/trackers/node-tracker/docs/markdown/node-tracker.buildpageping.md
@@ -16,9 +16,11 @@ declare function buildPagePing(event: PagePingEvent): PayloadBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | PagePingEvent | Contains the properties for the Page Ping event  PayloadBuilder to be sent to  |
+|  event | PagePingEvent | Contains the properties for the Page Ping event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildpageview.md b/trackers/node-tracker/docs/markdown/node-tracker.buildpageview.md
@@ -16,9 +16,11 @@ declare function buildPageView(event: PageViewEvent): PayloadBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | PageViewEvent | Contains the properties for the Page View event  PayloadBuilder to be sent to  |
+|  event | PageViewEvent | Contains the properties for the Page View event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildremovefromcart.md b/trackers/node-tracker/docs/markdown/node-tracker.buildremovefromcart.md
@@ -16,9 +16,11 @@ declare function buildRemoveFromCart(event: RemoveFromCartEvent): PayloadBuilder
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | RemoveFromCartEvent | Contains the properties for the Remove From Cart event  PayloadBuilder to be sent to  |
+|  event | RemoveFromCartEvent | Contains the properties for the Remove From Cart event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildscreenview.md b/trackers/node-tracker/docs/markdown/node-tracker.buildscreenview.md
@@ -16,9 +16,11 @@ declare function buildScreenView(event: ScreenViewEvent): PayloadBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | ScreenViewEvent | Contains the properties for the Screen View event. One or more properties must be included.  PayloadBuilder to be sent to  |
+|  event | ScreenViewEvent | Contains the properties for the Screen View event. One or more properties must be included. |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildselfdescribingevent.md b/trackers/node-tracker/docs/markdown/node-tracker.buildselfdescribingevent.md
@@ -16,9 +16,11 @@ declare function buildSelfDescribingEvent(event: SelfDescribingEvent): PayloadBu
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | SelfDescribingEvent | Contains the properties and schema location for the event  PayloadBuilder to be sent to  |
+|  event | SelfDescribingEvent | Contains the properties and schema location for the event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildsitesearch.md b/trackers/node-tracker/docs/markdown/node-tracker.buildsitesearch.md
@@ -16,9 +16,11 @@ declare function buildSiteSearch(event: SiteSearchEvent): PayloadBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | SiteSearchEvent | Contains the properties for the Site Search event  PayloadBuilder to be sent to  |
+|  event | SiteSearchEvent | Contains the properties for the Site Search event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildsocialinteraction.md b/trackers/node-tracker/docs/markdown/node-tracker.buildsocialinteraction.md
@@ -4,7 +4,7 @@
 
 ## buildSocialInteraction() function
 
-Build a Social Interaction Event<!-- -->\\ Social tracking will be used to track the way users interact with Facebook, Twitter and Google + widgets e.g. to capture “like this” or “tweet this” events.
+Build a Social Interaction Event Social tracking will be used to track the way users interact with Facebook, Twitter and Google + widgets e.g. to capture “like this” or “tweet this” events.
 
 <b>Signature:</b>
 
@@ -16,9 +16,11 @@ declare function buildSocialInteraction(event: SocialInteractionEvent): PayloadB
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | SocialInteractionEvent | Contains the properties for the Social Interaction event  PayloadBuilder to be sent to  |
+|  event | SocialInteractionEvent | Contains the properties for the Social Interaction event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildstructevent.md b/trackers/node-tracker/docs/markdown/node-tracker.buildstructevent.md
@@ -16,9 +16,11 @@ declare function buildStructEvent(event: StructuredEvent): PayloadBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  event | StructuredEvent | Contains the properties for the Structured event  PayloadBuilder to be sent to  |
+|  event | StructuredEvent | Contains the properties for the Structured event |
 
 <b>Returns:</b>
 
 PayloadBuilder
 
+PayloadBuilder to be sent to 
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.activatecoreplugin.md b/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.activatecoreplugin.md
@@ -6,10 +6,13 @@
 
 Called when the plugin is initialised during the trackerCore construction
 
- Use to capture the specific core instance for each instance of a core plugin
-
 <b>Signature:</b>
 
 ```typescript
 activateCorePlugin?: (core: TrackerCore) => void;
 ```
+
+## Remarks
+
+Use to capture the specific core instance for each instance of a core plugin
+
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.md b/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.md
@@ -16,7 +16,7 @@ interface CorePlugin
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [activateCorePlugin?](./node-tracker.coreplugin.activatecoreplugin.md) | (core: TrackerCore) =&gt; void | <i>(Optional)</i> Called when the plugin is initialised during the trackerCore construction Use to capture the specific core instance for each instance of a core plugin |
+|  [activateCorePlugin?](./node-tracker.coreplugin.activatecoreplugin.md) | (core: TrackerCore) =&gt; void | <i>(Optional)</i> Called when the plugin is initialised during the trackerCore construction |
 |  [afterTrack?](./node-tracker.coreplugin.aftertrack.md) | (payload: Payload) =&gt; void | <i>(Optional)</i> Called just after the trackerCore callback fires |
 |  [beforeTrack?](./node-tracker.coreplugin.beforetrack.md) | (payloadBuilder: PayloadBuilder) =&gt; void | <i>(Optional)</i> Called just before the trackerCore callback fires |
 |  [contexts?](./node-tracker.coreplugin.contexts.md) | () =&gt; SelfDescribingJson\[\] | <i>(Optional)</i> Called when constructing the context for each event Useful for adding additional context to events |
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.md b/trackers/node-tracker/docs/markdown/node-tracker.md
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.md b/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.md
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.pagetitle.md b/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.pagetitle.md
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.pageurl.md b/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.pageurl.md
diff --git a/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.referrer.md b/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.referrer.md
