From 6e3785e255862f1c927b040ef9603e05dc36dde1 Mon Sep 17 00:00:00 2001 From: "rafaelw@chromium.org" Date: Tue, 22 Sep 2009 00:20:08 +0000 Subject: Extension Doc Changes (no building or testable changes). Removing stray comma that was breaking the extension docs build. TBR=aa Review URL: http://codereview.chromium.org/217009 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@26769 0039d316-1c4b-4281-b951-d872f2087c98 --- chrome/common/extensions/api/extension_api.json | 2 +- chrome/common/extensions/docs/tabs.html | 950 +++++++++++++++++++----- 2 files changed, 772 insertions(+), 180 deletions(-) (limited to 'chrome/common') diff --git a/chrome/common/extensions/api/extension_api.json b/chrome/common/extensions/api/extension_api.json index 9e36615..1d49a6c 100755 --- a/chrome/common/extensions/api/extension_api.json +++ b/chrome/common/extensions/api/extension_api.json @@ -621,7 +621,7 @@ "description": "Note:css are injected in the following definition order.", "properties": { "code": {"type": "string", "optional": true, "description": "CSS code to be injected."}, - "file": {"type": "string", "optional": true, "description": "CSS file to be injected."}, + "file": {"type": "string", "optional": true, "description": "CSS file to be injected."} }, "optional": true }, diff --git a/chrome/common/extensions/docs/tabs.html b/chrome/common/extensions/docs/tabs.html index f3c5e32..7c76c18 100755 --- a/chrome/common/extensions/docs/tabs.html +++ b/chrome/common/extensions/docs/tabs.html @@ -173,16 +173,20 @@
  • detectLanguage
  • - get + executeScript
  • - getAllInWindow + get
  • - getSelected + getAllInWindow
  • - move + getSelected
  • + insertCSS +
  • + move +
  • remove -
  • +
  • update
    • @@ -1173,18 +1177,21 @@ For example:
    - -

    get

    + +

    executeScript

    -
    void +
    boolean - chrome.tabs.get(, integer - tabId, function + chrome.tabs.executeScript(, integer + tabId, object + scriptDef, function callback)
    - -

    Retrieves details about the specified tab.

    +

    Undocumented.

    +

    + A description from the json schema def of the function goes here. +

    Parameters

    @@ -1198,7 +1205,7 @@ For example:
    ( - + optional Type @@ -1215,12 +1222,10 @@ For example: -
    +
    -
    - Description of this parameter from the json schema. -
    +
    The id of tab which run the script, default to selected tab of current window.
    @@ -1232,16 +1237,16 @@ For example:
    -
    +
    - callback + scriptDef
    ( - + optional Type @@ -1250,7 +1255,7 @@ For example: array of - function + object ) @@ -1258,66 +1263,33 @@ For example:
    -
    +
    -
    - Description of this parameter from the json schema. -
    +
    Note:scripts are injected in the following definition order.
    -
    +
    -
    -
    -
    -
    -
    -
    -
    -
    - - - -

    Returns

    -
    -
    -
    -
    -
    -
    - - +
    -
    -

    Callback function

    -

    - If you specify the callback parameter, - it should specify a function that looks like this: -

    - - - 
    function(Tab tab) {...});
    -
    -
    -
    - tab + code
    ( - + optional - - Tab - - + Type + + + array of - paramType + string ) @@ -1325,12 +1297,10 @@ For example:
    -
    +
    -
    - Description of this parameter from the json schema. -
    +
    JavaScript code to execute.
    @@ -1342,34 +1312,10 @@ For example:
    -
    - -
    -
    - -
    - -
    - -

    getAllInWindow

    - -
    void - - chrome.tabs.getAllInWindow(, integer - windowId, function - callback)
    - -
    - -

    Gets details about all tabs in the specified window.

    - - -

    Parameters

    -
    -
    -
    +
    +
    - windowId + file @@ -1384,7 +1330,7 @@ For example: array of - integer + string ) @@ -1395,7 +1341,7 @@ For example:
    -
    Defaults to the current window.
    +
    JavaScript file to execute.
    @@ -1407,7 +1353,11 @@ For example:
    -
    +
    + + + +
    callback @@ -1416,7 +1366,7 @@ For example:
    ( - + optional Type @@ -1433,12 +1383,10 @@ For example:
    -
    +
    -
    - Description of this parameter from the json schema. -
    +
    When all scripts are executed, this callback is called.
    @@ -1454,30 +1402,12 @@ For example: -

    Returns

    +

    Returns

    -
    -
    -
    -
    -
    - - -
    -

    Callback function

    -

    - If you specify the callback parameter, - it should specify a function that looks like this: -

    - - - 
    function(array of Tab tabs) {...});
    -
    -
    -
    +
    - tabs + paramName @@ -1489,20 +1419,10 @@ For example: Type - - array of - - Tab - - - + array of - paramType - - - - paramType + boolean ) @@ -1510,12 +1430,10 @@ For example:
    -
    +
    -
    - Description of this parameter from the json schema. -
    +
    Whether this call is successful
    @@ -1527,6 +1445,24 @@ For example:
    +
    + + + +
    +
    +

    Callback function

    +

    + If you specify the callback parameter, + it should specify a function that looks like this: +

    + + + 
    function() {...});
    +
    +
    +
    +
    @@ -1534,19 +1470,19 @@ For example:
    -
    - -

    getSelected

    +
    + +

    get

    void - chrome.tabs.getSelected(, integer - windowId, function + chrome.tabs.get(, integer + tabId, function callback)
    -

    Gets the tab that is selected in the specified window.

    +

    Retrieves details about the specified tab.

    Parameters

    @@ -1554,13 +1490,13 @@ For example:
    - windowId + tabId
    ( - optional + Type @@ -1577,10 +1513,12 @@ For example:
    -
    Undocumented.
    -
    Defaults to the current window.
    +
    + Description of this parameter from the json schema. +
    @@ -1709,20 +1647,19 @@ For example:
    -
    - -

    move

    +
    + +

    getAllInWindow

    void - chrome.tabs.move(, integer - tabId, object - moveProperties, function + chrome.tabs.getAllInWindow(, integer + windowId, function callback)
    -

    Move a tab to a new position within its window, or to a new window.

    +

    Gets details about all tabs in the specified window.

    Parameters

    @@ -1730,13 +1667,13 @@ For example:
    - tabId + windowId
    ( - + optional Type @@ -1753,12 +1690,10 @@ For example:
    -
    +
    -
    - Description of this parameter from the json schema. -
    +
    Defaults to the current window.
    @@ -1770,10 +1705,10 @@ For example:
    -
    +
    - moveProperties + callback @@ -1788,7 +1723,7 @@ For example: array of - object + function ) @@ -1804,18 +1739,675 @@ For example: -
    +
    -
    +
    -
    - windowId - - - -
    - ( - optional +
    +
    +
    +
    +
    +
    + + + +

    Returns

    +
    +
    +
    +
    +
    +
    + + +
    +
    +

    Callback function

    +

    + If you specify the callback parameter, + it should specify a function that looks like this: +

    + + + 
    function(array of Tab tabs) {...});
    +
    +
    +
    +
    + tabs + + + +
    + ( + + + + Type + + + + array of + + Tab + + + + array of + + paramType + + + + paramType + + + ) +
    + +     +
    +
    + Undocumented. +
    +
    + Description of this parameter from the json schema. +
    + + +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + +
    + +
    + +

    getSelected

    + +
    void + + chrome.tabs.getSelected(, integer + windowId, function + callback)
    + +
    + +

    Gets the tab that is selected in the specified window.

    + + +

    Parameters

    +
    +
    +
    +
    + windowId + + + +
    + ( + optional + + + Type + + + + array of + + integer + + + ) +
    + +     +
    + +
    Defaults to the current window.
    + + +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + callback + + + +
    + ( + + + + Type + + + + array of + + function + + + ) +
    + +     +
    +
    + Undocumented. +
    +
    + Description of this parameter from the json schema. +
    + + +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + + +

    Returns

    +
    +
    +
    +
    +
    +
    + + +
    +
    +

    Callback function

    +

    + If you specify the callback parameter, + it should specify a function that looks like this: +

    + + + 
    function(Tab tab) {...});
    +
    +
    +
    +
    + tab + + + +
    + ( + + + + Tab + + + + array of + + paramType + + + ) +
    + +     +
    +
    + Undocumented. +
    +
    + Description of this parameter from the json schema. +
    + + +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + +
    + +
    + +

    insertCSS

    + +
    boolean + + chrome.tabs.insertCSS(, integer + tabId, object + scriptDef, function + callback)
    + +
    +

    Undocumented.

    +

    + A description from the json schema def of the function goes here. +

    + + +

    Parameters

    +
    +
    +
    +
    + tabId + + + +
    + ( + optional + + + Type + + + + array of + + integer + + + ) +
    + +     +
    + +
    The id of tab which run the script, default to selected tab of current window.
    + + +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + scriptDef + + + +
    + ( + optional + + + Type + + + + array of + + object + + + ) +
    + +     +
    + +
    Note:css are injected in the following definition order.
    + + +
    +
    +
    +
    +
    + code + + + +
    + ( + optional + + + Type + + + + array of + + string + + + ) +
    + +     +
    + +
    CSS code to be injected.
    + + +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + file + + + +
    + ( + optional + + + Type + + + + array of + + string + + + ) +
    + +     +
    + +
    CSS file to be injected.
    + + +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + callback + + + +
    + ( + optional + + + Type + + + + array of + + function + + + ) +
    + +     +
    + +
    When all css are inserted, this callback is called.
    + + +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + + +

    Returns

    +
    +
    +
    +
    + paramName + + + +
    + ( + + + + Type + + + + array of + + boolean + + + ) +
    + +     +
    + +
    Whether this call is successful
    + + +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + + +
    +
    +

    Callback function

    +

    + If you specify the callback parameter, + it should specify a function that looks like this: +

    + + + 
    function() {...});
    +
    +
    +
    +
    +
    +
    +
    +
    + +
    + +
    + +

    move

    + +
    void + + chrome.tabs.move(, integer + tabId, object + moveProperties, function + callback)
    + +
    + +

    Move a tab to a new position within its window, or to a new window.

    + + +

    Parameters

    +
    +
    +
    +
    + tabId + + + +
    + ( + + + + Type + + + + array of + + integer + + + ) +
    + +     +
    +
    + Undocumented. +
    +
    + Description of this parameter from the json schema. +
    + + +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + moveProperties + + + +
    + ( + + + + Type + + + + array of + + object + + + ) +
    + +     +
    +
    + Undocumented. +
    +
    + Description of this parameter from the json schema. +
    + + +
    +
    +
    +
    +
    + windowId + + + +
    + ( + optional Type @@ -2007,7 +2599,7 @@ For example:
    -
    +

    remove

    @@ -2144,7 +2736,7 @@ For example:
    -
    +

    update

    -- cgit v1.1