diff options
author | rafaelw@chromium.org <rafaelw@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2010-09-10 17:55:10 +0000 |
---|---|---|
committer | rafaelw@chromium.org <rafaelw@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2010-09-10 17:55:10 +0000 |
commit | 4535a2b25d3b6e3a331bbec8df1068c3d3f11b82 (patch) | |
tree | 44b8bb190f6faae0e446b9acbbfbe237bd682363 /chrome/common/extensions | |
parent | 5b23a5b85c0f8294cf5032552a52cc56cd323a43 (diff) | |
download | chromium_src-4535a2b25d3b6e3a331bbec8df1068c3d3f11b82.zip chromium_src-4535a2b25d3b6e3a331bbec8df1068c3d3f11b82.tar.gz chromium_src-4535a2b25d3b6e3a331bbec8df1068c3d3f11b82.tar.bz2 |
Add a note saying that not all functions require the tabs
permission to use.
Landing: http://codereview.chromium.org/3329022/show for finnur who can't currently build extension docs.
TBR=finnur
BUG=43743
TEST=None (doc change)
Review URL: http://codereview.chromium.org/3367024
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@59113 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/common/extensions')
-rw-r--r-- | chrome/common/extensions/api/extension_api.json | 4 | ||||
-rw-r--r-- | chrome/common/extensions/docs/experimental.management.html | 68 | ||||
-rw-r--r-- | chrome/common/extensions/docs/experimental.sidebar.html | 2 | ||||
-rw-r--r-- | chrome/common/extensions/docs/samples.json | 1 | ||||
-rw-r--r-- | chrome/common/extensions/docs/static/tabs.html | 3 | ||||
-rw-r--r-- | chrome/common/extensions/docs/tabs.html | 7 |
6 files changed, 9 insertions, 76 deletions
diff --git a/chrome/common/extensions/api/extension_api.json b/chrome/common/extensions/api/extension_api.json index 9dfe030..da9126d 100644 --- a/chrome/common/extensions/api/extension_api.json +++ b/chrome/common/extensions/api/extension_api.json @@ -938,7 +938,7 @@ { "name": "create", "type": "function", - "description": "Creates a new tab.", + "description": "Creates a new tab. Note: This function can be used without requesting the 'tabs' permission in the manifest.", "parameters": [ { "type": "object", @@ -985,7 +985,7 @@ { "name": "update", "type": "function", - "description": "Modifies the properties of a tab. Properties that are not specified in <var>updateProperties</var> are not modified.", + "description": "Modifies the properties of a tab. Properties that are not specified in <var>updateProperties</var> are not modified. Note: This function can be used without requesting the 'tabs' permission in the manifest.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0}, { diff --git a/chrome/common/extensions/docs/experimental.management.html b/chrome/common/extensions/docs/experimental.management.html index 0631798..663f432 100644 --- a/chrome/common/extensions/docs/experimental.management.html +++ b/chrome/common/extensions/docs/experimental.management.html @@ -257,8 +257,6 @@ <ol> <li> <a href="#method-getAll">getAll</a> - </li><li style="display: none; "> - <a href="#method-anchor">methodName</a> </li><li> <a href="#method-setEnabled">setEnabled</a> </li><li> @@ -524,72 +522,6 @@ </p> </div> <!-- /description --> - </div><div class="apiItem" style="display: none; "> - <a></a> <!-- method-anchor --> - <h4>method name</h4> - - <div class="summary"><span>void</span> - <!-- Note: intentionally longer 80 columns --> - <span>chrome.module.methodName</span>(<span><span>, </span><span></span> - <var><span></span></var></span>)</div> - - <div class="description"> - <p class="todo">Undocumented.</p> - <p> - A description from the json schema def of the function goes here. - </p> - - <!-- PARAMETERS --> - <h4>Parameters</h4> - <dl> - <div> - <div> - </div> - </div> - </dl> - - <!-- RETURNS --> - <h4>Returns</h4> - <dl> - <div> - <div> - </div> - </div> - </dl> - - <!-- CALLBACK --> - <div> - <div> - <h4>Callback function</h4> - <p> - The callback <em>parameter</em> should specify a function - that looks like this: - </p> - <p> - If you specify the <em>callback</em> parameter, it should - specify a function that looks like this: - </p> - - <!-- Note: intentionally longer 80 columns --> - <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> - <dl> - <div> - <div> - </div> - </div> - </dl> - </div> - </div> - - <!-- MIN_VERSION --> - <p> - This function was added in version <b><span></span></b>. - If you require this function, the manifest key - <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> - can ensure that your extension won't be run in an earlier browser version. - </p> - </div> <!-- /description --> - </div><div class="apiItem"> <a name="method-setEnabled"></a> <!-- method-anchor --> <h4>setEnabled</h4> diff --git a/chrome/common/extensions/docs/experimental.sidebar.html b/chrome/common/extensions/docs/experimental.sidebar.html index b74d698..fb092eb 100644 --- a/chrome/common/extensions/docs/experimental.sidebar.html +++ b/chrome/common/extensions/docs/experimental.sidebar.html @@ -938,7 +938,7 @@ <dd class="todo" style="display: none; "> Undocumented. </dd> - <dd>'hidden' indicates sidebar is not defined for the specified tab (show was never called or hide() was called). Nothing is displayed for this sidebar.'shown' means sidebar is defined for the specified tab; mini tab is displayed for this sidebar. Sidebar UI is either collapsed or displaying a content of some other extension's sidebar.'active' indicates that sidebar is defined for the specified tab; sidebar UI is expanded and displaying this sidebar's content.</dd> + <dd>'hidden' indicates sidebar is not defined for the specified tab (show was never called or hide() was called). Nothing is displayed for this sidebar.<br>'shown' means sidebar is defined for the specified tab; mini tab is displayed for this sidebar. Sidebar UI is either collapsed or displaying a content of some other extension's sidebar.<br>'active' indicates that sidebar is defined for the specified tab; sidebar UI is expanded and displaying this sidebar's content.</dd> <dd style="display: none; "> This parameter was added in version <b><span></span></b>. diff --git a/chrome/common/extensions/docs/samples.json b/chrome/common/extensions/docs/samples.json index 4756b19..0188c72 100644 --- a/chrome/common/extensions/docs/samples.json +++ b/chrome/common/extensions/docs/samples.json @@ -109,7 +109,6 @@ "chrome.tabs.onMoved": "tabs.html#event-onMoved", "chrome.experimental.omnibox.sendSuggestions": "experimental.omnibox.html#method-sendSuggestions", "chrome.bookmarks.update": "bookmarks.html#method-update", - "chrome.experimental.management.install": "experimental.management.html#method-install", "chrome.contextMenus.removeAll": "contextMenus.html#method-removeAll", "chrome.windows.remove": "windows.html#method-remove", "chrome.tabs.sendRequest": "tabs.html#method-sendRequest", diff --git a/chrome/common/extensions/docs/static/tabs.html b/chrome/common/extensions/docs/static/tabs.html index b20ee50..9d90556 100644 --- a/chrome/common/extensions/docs/static/tabs.html +++ b/chrome/common/extensions/docs/static/tabs.html @@ -12,7 +12,7 @@ create, modify, and rearrange tabs in the browser. width="323" height="50" alt="Two tabs in a window" /> <h2 id="manifest">Manifest</h2> -<p>You must declare the "tabs" permission in your extension's manifest to use the tabs API. +<p>All but two functions* require you to declare the "tabs" permission in your extension's manifest to use the tabs API. For example: </p> @@ -25,6 +25,7 @@ For example: ... }</pre> +<p>* The two functions that do not require the "tabs" permission are: tabs.create and tabs.update</p> <h2 id="examples"> Examples </h2> <p> diff --git a/chrome/common/extensions/docs/tabs.html b/chrome/common/extensions/docs/tabs.html index f086520..17799d1 100644 --- a/chrome/common/extensions/docs/tabs.html +++ b/chrome/common/extensions/docs/tabs.html @@ -346,7 +346,7 @@ create, modify, and rearrange tabs in the browser. <img src="images/tabs.png" width="323" height="50" alt="Two tabs in a window"> <h2 id="manifest">Manifest</h2> -<p>You must declare the "tabs" permission in your extension's manifest to use the tabs API. +<p>All but two functions* require you to declare the "tabs" permission in your extension's manifest to use the tabs API. For example: </p> @@ -359,6 +359,7 @@ For example: ... }</pre> +<p>* The two functions that do not require the "tabs" permission are: tabs.create and tabs.update</p> <h2 id="examples"> Examples </h2> <p> @@ -1112,7 +1113,7 @@ For other examples and for help in viewing the source code, see <div class="description"> <p class="todo" style="display: none; ">Undocumented.</p> - <p>Creates a new tab.</p> + <p>Creates a new tab. Note: This function can be used without requesting the 'tabs' permission in the manifest.</p> <!-- PARAMETERS --> <h4>Parameters</h4> @@ -4486,7 +4487,7 @@ For other examples and for help in viewing the source code, see <div class="description"> <p class="todo" style="display: none; ">Undocumented.</p> - <p>Modifies the properties of a tab. Properties that are not specified in <var>updateProperties</var> are not modified.</p> + <p>Modifies the properties of a tab. Properties that are not specified in <var>updateProperties</var> are not modified. Note: This function can be used without requesting the 'tabs' permission in the manifest.</p> <!-- PARAMETERS --> <h4>Parameters</h4> |