Bug 1503501 - Fix some markup references in windows API docs; r=me DONTBUILD
authorGeoff Lankow <geoff@darktrojan.net>
Thu, 03 Jan 2019 22:40:18 +1300
changeset 33254 6689956229af
parent 33253 4b0504aafd00
child 33255 54215be7c803
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)
reviewersme
bugs1503501
Bug 1503501 - Fix some markup references in windows API docs; r=me DONTBUILD
mail/components/extensions/schemas/windows.json
--- a/mail/components/extensions/schemas/windows.json
+++ b/mail/components/extensions/schemas/windows.json
@@ -1,68 +1,68 @@
 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 [
   {
     "namespace": "windows",
-    "description": "Use the <code>browser.windows</code> API to interact with browser windows. You can use this API to create, modify, and rearrange windows in the browser.",
+    "description": "Use the <code>browser.windows</code> API to interact with Thunderbird. You can use this API to create, modify, and rearrange windows.",
     "types": [
       {
         "id": "WindowType",
         "type": "string",
-        "description": "The type of browser window this is. Under some circumstances a Window may not be assigned type property, for example when querying closed windows from the $(ref:sessions) API.",
+        "description": "The type of window this is. Under some circumstances a Window may not be assigned type property.",
         "enum": ["normal", "popup", "panel", "app", "devtools"]
       },
       {
         "id": "WindowState",
         "type": "string",
-        "description": "The state of this browser window. Under some circumstances a Window may not be assigned state property, for example when querying closed windows from the $(ref:sessions) API.",
+        "description": "The state of this window.",
         "enum": ["normal", "minimized", "maximized", "fullscreen", "docked"]
       },
       {
         "id": "Window",
         "type": "object",
         "properties": {
           "id": {
             "type": "integer",
             "optional": true,
             "minimum": 0,
-            "description": "The ID of the window. Window IDs are unique within a browser session. Under some circumstances a Window may not be assigned an ID, for example when querying windows using the $(ref:sessions) API, in which case a session ID may be present."
+            "description": "The ID of the window. Window IDs are unique within a session."
           },
           "focused": {
             "type": "boolean",
             "description": "Whether the window is currently the focused window."
           },
           "top": {
             "type": "integer",
             "optional": true,
-            "description": "The offset of the window from the top edge of the screen in pixels. Under some circumstances a Window may not be assigned top property, for example when querying closed windows from the $(ref:sessions) API."
+            "description": "The offset of the window from the top edge of the screen in pixels."
           },
           "left": {
             "type": "integer",
             "optional": true,
-            "description": "The offset of the window from the left edge of the screen in pixels. Under some circumstances a Window may not be assigned left property, for example when querying closed windows from the $(ref:sessions) API."
+            "description": "The offset of the window from the left edge of the screen in pixels."
           },
           "width": {
             "type": "integer",
             "optional": true,
-            "description": "The width of the window, including the frame, in pixels. Under some circumstances a Window may not be assigned width property, for example when querying closed windows from the $(ref:sessions) API."
+            "description": "The width of the window, including the frame, in pixels."
           },
           "height": {
             "type": "integer",
             "optional": true,
-            "description": "The height of the window, including the frame, in pixels. Under some circumstances a Window may not be assigned height property, for example when querying closed windows from the $(ref:sessions) API."
+            "description": "The height of the window, including the frame, in pixels."
           },
           "tabs": {
             "type": "array",
             "items": { "$ref": "tabs.Tab" },
             "optional": true,
-            "description": "Array of $(ref:tabs.Tab) objects representing the current tabs in the window."
+            "description": "Array of :ref:`tabs.Tab` objects representing the current tabs in the window."
           },
           "incognito": {
             "type": "boolean",
             "description": "Whether the window is incognito."
           },
           "type": {
             "$ref": "WindowType",
             "optional": true,
@@ -72,21 +72,16 @@
             "$ref": "WindowState",
             "optional": true,
             "description": "The state of this browser window."
           },
           "alwaysOnTop": {
             "type": "boolean",
             "description": "Whether the window is set to be always on top."
           },
-          "sessionId": {
-            "type": "string",
-            "optional": true,
-            "description": "The session ID used to uniquely identify a Window obtained from the $(ref:sessions) API."
-          },
           "title": {
             "type": "string",
             "optional": true,
             "description": "The title of the window. Read-only."
           }
         }
       },
       {
@@ -94,21 +89,21 @@
         "type": "string",
         "description": "Specifies what type of browser window to create. The 'panel' and 'detached_panel' types create a popup unless the '--enable-panels' flag is set.",
         "enum": ["normal", "popup", "panel", "detached_panel"]
       }
     ],
     "properties": {
       "WINDOW_ID_NONE": {
         "value": -1,
-        "description": "The windowId value that represents the absence of a browser window."
+        "description": "The windowId value that represents the absence of a window."
       },
       "WINDOW_ID_CURRENT": {
         "value": -2,
-        "description": "The windowId value that represents the $(topic:current-window)[current window]."
+        "description": "The windowId value that represents the current window."
       }
     },
     "functions": [
       {
         "name": "get",
         "type": "function",
         "description": "Gets details about a window.",
         "async": "callback",
@@ -122,25 +117,25 @@
             "type": "object",
             "name": "getInfo",
             "optional": true,
             "description": "",
             "properties": {
               "populate": {
                 "type": "boolean",
                 "optional": true,
-                "description": "If true, the $(ref:windows.Window) object will have a <var>tabs</var> property that contains a list of the $(ref:tabs.Tab) objects. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission."
+                "description": "If true, the :ref:`windows.Window` object will have a <var>tabs</var> property that contains a list of the :ref:`tabs.Tab` objects. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission."
               },
               "windowTypes": {
                 "type": "array",
                 "items": {
                   "$ref": "WindowType"
                 },
                 "optional": true,
-                "description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows."
+                "description": "If set, the :ref:`windows.Window` returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows."
               }
             }
           },
           {
             "type": "function",
             "name": "callback",
             "parameters": [
               {
@@ -149,35 +144,35 @@
               }
             ]
           }
         ]
       },
       {
         "name": "getCurrent",
         "type": "function",
-        "description": "Gets the $(topic:current-window)[current window].",
+        "description": "Gets the current window.",
         "async": "callback",
         "parameters": [
           {
             "type": "object",
             "name": "getInfo",
             "optional": true,
             "description": "",
             "properties": {
               "populate": {
                 "type": "boolean",
                 "optional": true,
-                "description": "If true, the $(ref:windows.Window) object will have a <var>tabs</var> property that contains a list of the $(ref:tabs.Tab) objects. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission."
+                "description": "If true, the :ref:`windows.Window` object will have a <var>tabs</var> property that contains a list of the :ref:`tabs.Tab` objects. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission."
               },
               "windowTypes": {
                 "type": "array",
                 "items": { "$ref": "WindowType" },
                 "optional": true,
-                "description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows."
+                "description": "If set, the :ref:`windows.Window` returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows."
               }
             }
           },
           {
             "type": "function",
             "name": "callback",
             "parameters": [
               {
@@ -198,23 +193,23 @@
             "type": "object",
             "name": "getInfo",
             "optional": true,
             "description": "",
             "properties": {
               "populate": {
                 "type": "boolean",
                 "optional": true,
-                "description": "If true, the $(ref:windows.Window) object will have a <var>tabs</var> property that contains a list of the $(ref:tabs.Tab) objects. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission."
+                "description": "If true, the :ref:`windows.Window` object will have a <var>tabs</var> property that contains a list of the :ref:`tabs.Tab` objects. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission."
               },
               "windowTypes": {
                 "type": "array",
                 "items": { "$ref": "WindowType" },
                 "optional": true,
-                "description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows."
+                "description": "If set, the :ref:`windows.Window` returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows."
               }
             }
           },
           {
             "type": "function",
             "name": "callback",
             "parameters": [
               {
@@ -235,23 +230,23 @@
             "type": "object",
             "name": "getInfo",
             "optional": true,
             "description": "",
             "properties": {
               "populate": {
                 "type": "boolean",
                 "optional": true,
-                "description": "If true, each $(ref:windows.Window) object will have a <var>tabs</var> property that contains a list of the $(ref:tabs.Tab) objects for that window. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission."
+                "description": "If true, each :ref:`windows.Window` object will have a <var>tabs</var> property that contains a list of the :ref:`tabs.Tab` objects for that window. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission."
               },
               "windowTypes": {
                 "type": "array",
                 "items": { "$ref": "WindowType" },
                 "optional": true,
-                "description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows."
+                "description": "If set, the :ref:`windows.Window` returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows."
               }
             }
           },
           {
             "type": "function",
             "name": "callback",
             "parameters": [
               {
@@ -495,17 +490,17 @@
             "minimum": 0,
             "description": "ID of the removed window."
           }
         ]
       },
       {
         "name": "onFocusChanged",
         "type": "function",
-        "description": "Fired when the currently focused window changes. Will be $(ref:windows.WINDOW_ID_NONE) if all browser windows have lost focus. Note: On some Linux window managers, WINDOW_ID_NONE will always be sent immediately preceding a switch from one browser window to another.",
+        "description": "Fired when the currently focused window changes. Will be :ref:`windows.WINDOW_ID_NONE`) if all browser windows have lost focus. Note: On some Linux window managers, WINDOW_ID_NONE will always be sent immediately preceding a switch from one browser window to another.",
         "filters": [
           {
             "name": "windowTypes",
             "type": "array",
             "items": { "$ref": "WindowType" },
             "description": "Conditions that the window's type being removed must satisfy. By default it will satisfy <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows."
           }
         ],