From: Ben Soares <b.soares@dundee.ac.uk>
Date: Wed, 7 Jun 2023 21:30:30 +0000 (+0100)
Subject: JAL-4001 Javadoc for the method to use
X-Git-Tag: Release_2_11_3_0~13^2~15
X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=0f80d9d589f1e38f4977457f91ee20159ba9907a;p=jalview.git

JAL-4001 Javadoc for the method to use
---

diff --git a/src/jalview/analytics/GoogleAnalytics4.java b/src/jalview/analytics/GoogleAnalytics4.java
index 5ae9c12..f7dd779 100644
--- a/src/jalview/analytics/GoogleAnalytics4.java
+++ b/src/jalview/analytics/GoogleAnalytics4.java
@@ -91,6 +91,19 @@ public class GoogleAnalytics4
     ENABLED = b;
   }
 
+  /**
+   * The simplest way to send an analytic event.
+   * 
+   * @param eventName
+   *          The event name. To emulate a webpage view use "page_view" and set
+   *          a "page_location" parameter. See
+   *          https://developers.google.com/analytics/devguides/collection/ga4/events?client_type=gtag
+   * @param paramsStrings
+   *          Optional multiple Strings in key, value pairs (there should be an
+   *          even number of paramsStrings) to be set as parameters of the
+   *          event. To emulate a webpage view use "page_location" as the URL in
+   *          a "page_view" event.
+   */
   public void sendAnalytics(String eventName, String... paramsStrings)
   {
     // clear out old lists