Bug 1503501 - Fix broken references in documentation; rs=docs-only
authorGeoff Lankow <geoff@darktrojan.net>
Tue, 15 Jan 2019 17:47:33 +1300
changeset 33345 7144956c64ee
parent 33344 4c5966ac10c4
child 33346 4ae0c5713dfe
push id2368
push userclokep@gmail.com
push dateMon, 28 Jan 2019 21:12:50 +0000
treeherdercomm-beta@56d23c07d815 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersdocs-only
bugs1503501
Bug 1503501 - Fix broken references in documentation; rs=docs-only
mail/components/extensions/schemas/mailTabs.json
mail/components/extensions/schemas/menus.json
mail/components/extensions/schemas/tabs.json
--- a/mail/components/extensions/schemas/mailTabs.json
+++ b/mail/components/extensions/schemas/mailTabs.json
@@ -55,17 +55,17 @@
           }
         }
       }
     ],
     "functions": [
       {
         "name": "query",
         "type": "function",
-        "description": "Gets all mail tabs that have the specified properties, or all tabs if no properties are specified.",
+        "description": "Gets all mail tabs that have the specified properties, or all mail tabs if no properties are specified.",
         "async": true,
         "parameters": [
           {
             "type": "object",
             "name": "queryInfo",
             "properties": {
               "active": {
                 "type": "boolean",
@@ -81,17 +81,17 @@
                 "type": "boolean",
                 "optional": true,
                 "description": "Whether the tabs are in the last focused window."
               },
               "windowId": {
                 "type": "integer",
                 "optional": true,
                 "minimum": -2,
-                "description": "The ID of the parent window, or $(ref:windows.WINDOW_ID_CURRENT) for the $(topic:current-window)[current window]."
+                "description": "The ID of the parent window, or :ref:`windows.WINDOW_ID_CURRENT` for the current window."
               }
             }
           }
         ]
       },
       {
         "name": "update",
         "type": "function",
--- a/mail/components/extensions/schemas/menus.json
+++ b/mail/components/extensions/schemas/menus.json
@@ -163,17 +163,17 @@
           }
         }
       }
     ],
     "functions": [
       {
         "name": "create",
         "type": "function",
-        "description": "Creates a new context menu item. Note that if an error occurs during creation, you may not find out until the creation callback fires (the details will be in $(ref:runtime.lastError)).",
+        "description": "Creates a new context menu item. Note that if an error occurs during creation, you may not find out until the creation callback fires (the details will be in `runtime.lastError <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/lastError>`_).",
         "returns": {
           "choices": [
             { "type": "integer" },
             { "type": "string" }
           ],
           "description": "The ID of the newly created item."
         },
         "parameters": [
@@ -255,17 +255,17 @@
                 ],
                 "optional": true,
                 "description": "The ID of a parent menu item; this makes the item a child of a previously added item."
               },
               "documentUrlPatterns": {
                 "type": "array",
                 "items": {"type": "string"},
                 "optional": true,
-                "description": "Lets you restrict the item to apply only to documents whose URL matches one of the given patterns. (This applies to frames as well.) For details on the format of a pattern, see $(topic:match_patterns)[Match Patterns]."
+                "description": "Lets you restrict the item to apply only to documents whose URL matches one of the given patterns. (This applies to frames as well.) For details on the format of a pattern, see `Match Patterns <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Match_patterns>`_."
               },
               "targetUrlPatterns": {
                 "type": "array",
                 "items": {"type": "string"},
                 "optional": true,
                 "description": "Similar to documentUrlPatterns, but lets you filter based on the src attribute of img/audio/video tags and the href of anchor tags."
               },
               "enabled": {
@@ -279,17 +279,17 @@
                 "description": "Specifies a command to issue for the context click.  Currently supports internal command _execute_browser_action."
               }
             }
           },
           {
             "type": "function",
             "name": "callback",
             "optional": true,
-            "description": "Called when the item has been created in the browser. If there were any problems creating the item, details will be available in $(ref:runtime.lastError).",
+            "description": "Called when the item has been created in the browser. If there were any problems creating the item, details will be available in `runtime.lastError <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/lastError>`_.",
             "parameters": []
           }
         ]
       },
       {
         "name": "update",
         "type": "function",
         "description": "Updates a previously created context menu item.",
--- a/mail/components/extensions/schemas/tabs.json
+++ b/mail/components/extensions/schemas/tabs.json
@@ -22,20 +22,20 @@
   {
     "namespace": "tabs",
     "description": "Use the <code>browser.tabs</code> API to interact with the browser's tab system. You can use this API to create, modify, and rearrange tabs in the browser.",
     "types": [
       {
         "id": "Tab",
         "type": "object",
         "properties": {
-          "id": {"type": "integer", "minimum": -1, "optional": true, "description": "The ID of the tab. Tab IDs are unique within a browser session. Under some circumstances a Tab may not be assigned an ID, for example when querying foreign tabs using the $(ref:sessions) API, in which case a session ID may be present. Tab ID can also be set to $(ref:tabs.TAB_ID_NONE) for apps and devtools windows."},
+          "id": {"type": "integer", "minimum": -1, "optional": true, "description": "The ID of the tab. Tab IDs are unique within a browser session. Under some circumstances a Tab may not be assigned an ID. Tab ID can also be set to :ref:`tabs.TAB_ID_NONE` for apps and devtools windows."},
           "index": {"type": "integer", "minimum": -1, "description": "The zero-based index of the tab within its window."},
           "windowId": {"type": "integer", "optional": true, "minimum": 0, "description": "The ID of the window the tab is contained within."},
-          "selected": {"type": "boolean", "description": "Whether the tab is selected.", "deprecated": "Please use $(ref:tabs.Tab.highlighted).", "unsupported": true},
+          "selected": {"type": "boolean", "description": "Whether the tab is selected.", "deprecated": "Please use :ref:`tabs.Tab.highlighted`.", "unsupported": true},
           "highlighted": {"type": "boolean", "description": "Whether the tab is highlighted. Works as an alias of active"},
           "active": {"type": "boolean", "description": "Whether the tab is active in its window. (Does not necessarily mean the window is focused.)"},
           "url": {"type": "string", "optional": true, "permissions": ["tabs"], "description": "The URL the tab is displaying. This property is only present if the extension's manifest includes the <code>\"tabs\"</code> permission."},
           "title": {"type": "string", "optional": true, "permissions": ["tabs"], "description": "The title of the tab. This property is only present if the extension's manifest includes the <code>\"tabs\"</code> permission."},
           "favIconUrl": {"type": "string", "optional": true, "permissions": ["tabs"], "description": "The URL of the tab's favicon. This property is only present if the extension's manifest includes the <code>\"tabs\"</code> permission. It may also be an empty string if the tab is loading."},
           "status": {"type": "string", "optional": true, "description": "Either <em>loading</em> or <em>complete</em>."},
           "width": {"type": "integer", "optional": true, "description": "The width of the tab in pixels."},
           "height": {"type": "integer", "optional": true, "description": "The height of the tab in pixels."},
@@ -143,33 +143,33 @@
           {
             "type": "object",
             "name": "createProperties",
             "properties": {
               "windowId": {
                 "type": "integer",
                 "minimum": -2,
                 "optional": true,
-                "description": "The window to create the new tab in. Defaults to the $(topic:current-window)[current window]."
+                "description": "The window to create the new tab in. Defaults to the current window."
               },
               "index": {
                 "type": "integer",
                 "minimum": 0,
                 "optional": true,
                 "description": "The position the tab should take in the window. The provided value will be clamped to between zero and the number of tabs in the window."
               },
               "url": {
                 "type": "string",
                 "optional": true,
                 "description": "The URL to navigate the tab to initially. Fully-qualified URLs must include a scheme (i.e. 'http://www.google.com', not 'www.google.com'). Relative URLs will be relative to the current page within the extension. Defaults to the New Tab Page."
               },
               "active": {
                 "type": "boolean",
                 "optional": true,
-                "description": "Whether the tab should become the active tab in the window. Does not affect whether the window is focused (see $(ref:windows.update)). Defaults to <var>true</var>."
+                "description": "Whether the tab should become the active tab in the window. Does not affect whether the window is focused (see :ref:`windows.update`). Defaults to <var>true</var>."
               },
               "selected": {
                 "deprecated": "Please use <em>active</em>.",
                 "unsupported": true,
                 "type": "boolean",
                 "optional": true,
                 "description": "Whether the tab should become the selected tab in the window. Defaults to <var>true</var>"
               }
@@ -205,17 +205,17 @@
           {
             "type": "function",
             "name": "callback",
             "optional": true,
             "parameters": [
               {
                 "name": "tab",
                 "optional": true,
-                "description": "Details about the duplicated tab. The $(ref:tabs.Tab) object doesn't contain <code>url</code>, <code>title</code> and <code>favIconUrl</code> if the <code>\"tabs\"</code> permission has not been requested.",
+                "description": "Details about the duplicated tab. The :ref:`tabs.Tab` object doesn't contain <code>url</code>, <code>title</code> and <code>favIconUrl</code> if the <code>\"tabs\"</code> permission has not been requested.",
                 "$ref": "Tab"
               }
             ]
           }
         ]
       },
       {
         "name": "query",
@@ -240,17 +240,17 @@
               "highlighted": {
                 "type": "boolean",
                 "optional": true,
                 "description": "Whether the tabs are highlighted.  Works as an alias of active."
               },
               "currentWindow": {
                 "type": "boolean",
                 "optional": true,
-                "description": "Whether the tabs are in the $(topic:current-window)[current window]."
+                "description": "Whether the tabs are in the current window."
               },
               "lastFocusedWindow": {
                 "type": "boolean",
                 "optional": true,
                 "description": "Whether the tabs are in the last focused window."
               },
               "status": {
                 "$ref": "TabStatus",
@@ -263,23 +263,23 @@
                 "description": "Match page titles against a pattern."
               },
               "url": {
                 "choices": [
                   {"type": "string"},
                   {"type": "array", "items": {"type": "string"}}
                 ],
                 "optional": true,
-                "description": "Match tabs against one or more $(topic:match_patterns)[URL patterns]. Note that fragment identifiers are not matched."
+                "description": "Match tabs against one or more `URL Patterns <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Match_patterns>`_. Note that fragment identifiers are not matched."
               },
               "windowId": {
                 "type": "integer",
                 "optional": true,
                 "minimum": -2,
-                "description": "The ID of the parent window, or $(ref:windows.WINDOW_ID_CURRENT) for the $(topic:current-window)[current window]."
+                "description": "The ID of the parent window, or :ref:`windows.WINDOW_ID_CURRENT` for the current window."
               },
               "windowType": {
                 "$ref": "WindowType",
                 "optional": true,
                 "description": "The type of window the tabs are in."
               },
               "index": {
                 "type": "integer",
@@ -310,44 +310,44 @@
         "description": "Modifies the properties of a tab. Properties that are not specified in <var>updateProperties</var> are not modified.",
         "async": "callback",
         "parameters": [
           {
             "type": "integer",
             "name": "tabId",
             "minimum": 0,
             "optional": true,
-            "description": "Defaults to the selected tab of the $(topic:current-window)[current window]."
+            "description": "Defaults to the selected tab of the current window."
           },
           {
             "type": "object",
             "name": "updateProperties",
             "properties": {
               "url": {
                 "type": "string",
                 "optional": true,
                 "description": "A URL to navigate the tab to."
               },
               "active": {
                 "type": "boolean",
                 "optional": true,
-                "description": "Whether the tab should be active. Does not affect whether the window is focused (see $(ref:windows.update))."
+                "description": "Whether the tab should be active. Does not affect whether the window is focused (see :ref:`windows.update`)."
               }
             }
           },
           {
             "type": "function",
             "name": "callback",
             "optional": true,
             "parameters": [
               {
                 "name": "tab",
                 "$ref": "Tab",
                 "optional": true,
-                "description": "Details about the updated tab. The $(ref:tabs.Tab) object doesn't contain <code>url</code>, <code>title</code> and <code>favIconUrl</code> if the <code>\"tabs\"</code> permission has not been requested."
+                "description": "Details about the updated tab. The :ref:`tabs.Tab` object doesn't contain <code>url</code>, <code>title</code> and <code>favIconUrl</code> if the <code>\"tabs\"</code> permission has not been requested."
               }
             ]
           }
         ]
       },
       {
         "name": "move",
         "type": "function",
@@ -449,17 +449,17 @@
             "optional": true,
             "parameters": []
           }
         ]
       },
       {
         "name": "executeScript",
         "type": "function",
-        "description": "Injects JavaScript code into a page. For details, see the $(topic:content_scripts)[programmatic injection] section of the content scripts doc.",
+        "description": "Injects JavaScript code into a page. For details, see the `programmatic injection <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Content_scripts>`_ section of the content scripts doc.",
         "async": "callback",
         "parameters": [
           {
             "type": "integer",
             "name": "tabId",
             "minimum": 0,
             "optional": true,
             "description": "The ID of the tab in which to run the script; defaults to the active tab of the current window."
@@ -484,17 +484,17 @@
               }
             ]
           }
         ]
       },
       {
         "name": "insertCSS",
         "type": "function",
-        "description": "Injects CSS into a page. For details, see the $(topic:content_scripts)[programmatic injection] section of the content scripts doc.",
+        "description": "Injects CSS into a page. For details, see the `programmatic injection <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Content_scripts>`_ section of the content scripts doc.",
         "async": "callback",
         "parameters": [
           {
             "type": "integer",
             "name": "tabId",
             "minimum": 0,
             "optional": true,
             "description": "The ID of the tab in which to insert the CSS; defaults to the active tab of the current window."
@@ -511,17 +511,17 @@
             "description": "Called when all the CSS has been inserted.",
             "parameters": []
           }
         ]
       },
       {
         "name": "removeCSS",
         "type": "function",
-        "description": "Removes injected CSS from a page. For details, see the $(topic:content_scripts)[programmatic injection] section of the content scripts doc.",
+        "description": "Removes injected CSS from a page. For details, see the `programmatic injection <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Content_scripts>`_ section of the content scripts doc.",
         "async": "callback",
         "parameters": [
           {
             "type": "integer",
             "name": "tabId",
             "minimum": 0,
             "optional": true,
             "description": "The ID of the tab from which to remove the injected CSS; defaults to the active tab of the current window."
@@ -595,17 +595,17 @@
             "optional": true,
             "description": "A set of filters that restricts the events that will be sent to this listener."
           }
         ]
       },
       {
         "name": "onMoved",
         "type": "function",
-        "description": "Fired when a tab is moved within a window. Only one move event is fired, representing the tab the user directly moved. Move events are not fired for the other tabs that must move in response. This event is not fired when a tab is moved between windows. For that, see $(ref:tabs.onDetached).",
+        "description": "Fired when a tab is moved within a window. Only one move event is fired, representing the tab the user directly moved. Move events are not fired for the other tabs that must move in response. This event is not fired when a tab is moved between windows. For that, see :ref:`tabs.onDetached`.",
         "parameters": [
           {"type": "integer", "name": "tabId", "minimum": 0},
           {
             "type": "object",
             "name": "moveInfo",
             "properties": {
               "windowId": {"type": "integer", "minimum": 0},
               "fromIndex": {"type": "integer", "minimum": 0},