docs

duckduckgo · Sep 25, 2024 · 9a0623b · 9a0623b
1 parent f456a88
commit 9a0623b
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 4 deletions.
diff --git a/build/app/public/js/base.js b/build/app/public/js/base.js
@@ -14377,7 +14377,6 @@
     /**
      * {@inheritDoc common.openInNewTab}
      * @type {import("./common.js").openInNewTab}
-     *
      * ```js
      * const payload = JSON.stringify({
      *     "url": "https://help.duckduckgo.com/duckduckgo-help-pages/privacy/web-tracking-protections/"
@@ -14428,6 +14427,10 @@
     /**
      * {@inheritDoc common.sendToggleReport}
      * @type {import("./common.js").sendToggleReport}
+     * @example
+     * ```js
+     * window.PrivacyDashboard.sendToggleReport()
+     * ```
      */
     sendToggleReport() {
       invariant(window.PrivacyDashboard?.sendToggleReport, "sendToggleReport missing");

diff --git a/guides/toggle-report.js b/guides/toggle-report.js
@@ -30,18 +30,23 @@
  * </details>
  *
  *   - WebKit: {@link "macOS integration".privacyDashboardGetToggleReportOptions}
- *   - Other platforms will be added
+ *   - Android: {@link "Android integration".PrivacyDashboardJavascriptInterface.getToggleReportOptions}
  *
  * ## Step 4: Implement new handlers
  *
  * The following are all sent in response to user interactions
  *
- * ### 👆Sending/rejecting the report
+ * ### 👆Sending the report
  *   - WebKit: {@link "macOS integration".privacyDashboardSendToggleReport}
+ *   - Android: {@link "Android integration".PrivacyDashboardJavascriptInterface.sendToggleReport}
+ *
+ * ### 👆Rejecting the report
  *   - WebKit: {@link "macOS integration".privacyDashboardRejectToggleReport}
+ *   - Android: {@link "Android integration".PrivacyDashboardJavascriptInterface.rejectToggleReport}
  *
  * ### 👆Tapping the 'see what's sent' list
  *   - Webkit: {@link "macOS integration".privacyDashboardSeeWhatIsSent}
+ *   - Android: {@link "Android integration".PrivacyDashboardJavascriptInterface.seeWhatIsSent}
  *
  * ### 👆Tapping anywhere on the success screen (macos only)
  *   - Webkit: {@link "macOS integration".privacyDashboardClose}

diff --git a/shared/js/browser/android-communication.js b/shared/js/browser/android-communication.js
@@ -292,7 +292,6 @@ export class PrivacyDashboardJavascriptInterface {
     /**
      * {@inheritDoc common.openInNewTab}
      * @type {import("./common.js").openInNewTab}
-     *
      * ```js
      * const payload = JSON.stringify({
      *     "url": "https://help.duckduckgo.com/duckduckgo-help-pages/privacy/web-tracking-protections/"
@@ -347,6 +346,10 @@ export class PrivacyDashboardJavascriptInterface {
     /**
      * {@inheritDoc common.sendToggleReport}
      * @type {import("./common.js").sendToggleReport}
+     * @example
+     * ```js
+     * window.PrivacyDashboard.sendToggleReport()
+     * ```
      */
     sendToggleReport() {
         invariant(window.PrivacyDashboard?.sendToggleReport, 'sendToggleReport missing')