tor-browser

commit 97ce24942ef543d96018f58c26619f9b5fd80a77
parent e70019a3f582fe0beaf597c1d40aff8242967f47
Author: John Bieling <john@thunderbird.net>
Date:   Thu,  2 Oct 2025 06:29:26 +0000

Bug 1991407 - Minor changes to descriptions of WebExtension API schema files. r=robwu

While working on Thunderbird's automatic source-to-documentation
process, I found a few entries in toolkit schema files, which could be improved.

1. The downloads API uses a parsable syntax for enum descriptions [1]. This patch is using the same syntax for the management API.

2. The storage API is not listing the "session" storage in one location

3. The runtime API has a broken reference to `$(ref:runtime.Port onDisconnect)`.

[1]:https://searchfox.org/firefox-main/rev/955360e8e3a773601c56f08069449d8d9261b873/toolkit/components/extensions/schemas/downloads.json#68

Differential Revision: https://phabricator.services.mozilla.com/D266627

Diffstat:
M
toolkit/components/extensions/schemas/management.json
 | 
2
+-
M
toolkit/components/extensions/schemas/runtime.json
 | 
2
+-
M
toolkit/components/extensions/schemas/storage.json
 | 
2
+-

3 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/toolkit/components/extensions/schemas/management.json b/toolkit/components/extensions/schemas/management.json
@@ -46,7 +46,7 @@
       },
       {
         "id": "ExtensionInstallType",
-        "description": "How the extension was installed. One of<br><var>development</var>: The extension was loaded unpacked in developer mode,<br><var>normal</var>: The extension was installed normally via an .xpi file,<br><var>sideload</var>: The extension was installed by other software on the machine,<br><var>admin</var>: The extension was installed by policy,<br><var>other</var>: The extension was installed by other means.",
+        "description": "How the extension was installed.<dl><dt>development</dt><dd>The extension was loaded unpacked in developer mode,</dd><dt>normal</dt><dd>The extension was installed normally via an .xpi file</dd><dt>sideload</dt><dd>The extension was installed by other software on the machine</dd><dt>admin</dt><dd>The extension was installed by policy</dd><dt>other</dt><dd>The extension was installed by other means.</dd></dl>",
         "type": "string",
         "enum": ["development", "normal", "sideload", "admin", "other"]
       },
diff --git a/toolkit/components/extensions/schemas/runtime.json b/toolkit/components/extensions/schemas/runtime.json
@@ -512,7 +512,7 @@
         ],
         "returns": {
           "$ref": "Port",
-          "description": "Port through which messages can be sent and received. The port's $(ref:runtime.Port onDisconnect) event is fired if the extension/app does not exist. "
+          "description": "Port through which messages can be sent and received. The port's $(ref:runtime.Port.onDisconnect) event is fired if the extension/app does not exist. "
         }
       },
       {
diff --git a/toolkit/components/extensions/schemas/storage.json b/toolkit/components/extensions/schemas/storage.json
@@ -203,7 +203,7 @@
           {
             "name": "areaName",
             "type": "string",
-            "description": "The name of the storage area (<code>\"sync\"</code>, <code>\"local\"</code> or <code>\"managed\"</code>) the changes are for."
+            "description": "The name of the storage area (<code>\"session\"</code>, <code>\"sync\"</code>, <code>\"local\"</code> or <code>\"managed\"</code>) the changes are for."
           }
         ]
       }