docs

duckduckgo · Oct 10, 2024 · 9668447 · 9668447
1 parent 6adef19
commit 9668447
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/build/app/public/js/base.js b/build/app/public/js/base.js
@@ -14392,7 +14392,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/"
@@ -14443,6 +14442,10 @@
     /**
      * {@inheritDoc common.sendToggleReport}
      * @type {import("./common.js").sendToggleReport}
+     * @example
+     * ```js
+     * window.PrivacyDashboard.sendToggleReport()
+     * ```
      */
     sendToggleReport() {
       invariant(window.PrivacyDashboard?.sendToggleReport, "sendToggleReport missing");

diff --git a/shared/js/browser/android-communication.js b/shared/js/browser/android-communication.js
@@ -291,7 +291,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/"
@@ -346,6 +345,10 @@ export class PrivacyDashboardJavascriptInterface {
     /**
      * {@inheritDoc common.sendToggleReport}
      * @type {import("./common.js").sendToggleReport}
+     * @example
+     * ```js
+     * window.PrivacyDashboard.sendToggleReport()
+     * ```
      */
     sendToggleReport() {
         invariant(window.PrivacyDashboard?.sendToggleReport, 'sendToggleReport missing')