Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(424)

Side by Side Diff: chrome/common/extensions/docs/devguide.html

Issue 165323: Add chrome.extension to extension_api.json and docs (Closed)
Patch Set: precommit Created 11 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mecha nism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is gener eated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTM L is also generated by an offline step so that this page may easily be indexed b y search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes t he single version of page template shell and the "instance" pages (bookmarks.htm l, etc...) can be generated with a build step. --><!-- <html> must retain id="te mplate --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> da ta is significant and loads the needed libraries and styles --><head jstcache="0 "> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache=" 0"> <title jscontent="pageTitle" jstcache="1">Devguide</title> <link href="css/A piRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="te xt/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstc ache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js " jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" js tcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body jstcache="0"> <div id="container" js tcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHe ader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id=" breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Exten sions</a> &gt; <a href="reference_index.html" jstcache="0">Reference</a> &gt; <a href="api_index.html" jstcache="0">chrome.* APIs</a> &gt; <span jscontent="h1He ader" jstcache="2">Devguide</span> </div> <div id="searchbox" jstcache="0"> <for m action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstc ache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtn o" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <inp ut type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" v alue="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="h ttp://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript " jstcache="0">google.load("elements", "1", {packages: "transliteration"});</scr ipt> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?for m=cse-search-box&amp;t13n_langs=en" jstcache="0"></script> <script type="text/ja vascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&amp;lang =en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jsconte nt="h1Header" jstcache="2">Devguide</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a>< /li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></l i> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html " jstcache="0">Manifest</a> </li><li jstcache="0"><a href="toolstrip.html" jstca che="0">Toolstrips</a> </li><li jstcache="0"><a href="pageActions.html" jstcache ="0">Page actions</a> </li><li jstcache="0"><a href="background_pages.html" jstc ache="0">Background pages</a> </li><li jstcache="0"><a href="content_scripts.htm l" jstcache="0">Content scripts</a> </li><li jstcache="0"><a href="tabs.html" js tcache="0">Tabs</a> </li><li jstcache="0"><a href="windows.html" jstcache="0">Wi ndows</a> </li><li jstcache="0"><a href="self.html" jstcache="0">Self</a> </li>< li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a> </li><li jst cache="0"><a href="packaging.html" jstcache="0">Packaging</a> </li><li jstcache= "0"><a href="autoupdate.html" jstcache="0">Autoupdate</a> </li></ul> </li><li js tcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1] </li><li jstcac he="0">[sample 2] </li></ul> </li></ul> </div> <div id="mainColumn" jstcache="0" > <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jst cache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <l i jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> < li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol > </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcac he="0"> <li jsselect="functions" jstcache="4"> <a jscontent="name" jsvalues=".hr ef:'#method-' + name" href="#method-anchor" jstcache="17">methodName</a> </li> < /ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstca che="0"> <li jsselect="events" jstcache="5"> <a jscontent="name" jsvalues=".href :'#event-' + name" href="#event-anchor" jstcache="18">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a hre f="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0">< a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PEND ING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </di v> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="stat ic" jstcache="0"><p jstcache="0"> [PENDING: intro to the guide goes here. say wh ere to go. lots o' links.] </p> <p jstcache="0"> Lorem ipsum dolor sit amet, con sectetur adipiscing elit. Fusce sed elit felis. Vestibulum porta mauris eget mi placerat a condimentum leo semper. Ut scelerisque, ipsum in cursus semper, lectu s enim molestie ante, a porttitor dolor neque sit amet lorem. Integer dignissim gravida eros ac rhoncus. Curabitur porttitor hendrerit dolor nec aliquam. Ut vul putate ultrices eros eu ultrices. Pellentesque tempor mattis odio in blandit. Pr oin nulla metus, tristique eget iaculis gravida, varius at leo. Ut dolor mi, auc tor et scelerisque vitae, volutpat eleifend magna. Pellentesque habitant morbi t ristique senectus et netus et malesuada fames ac turpis egestas. Morbi ut risus nec massa consectetur accumsan sed non est. Fusce ornare eros et felis dignissim convallis. Maecenas condimentum purus eget nisl condimentum vitae ornare diam s ollicitudin. Nulla et dictum ante. In lacus odio, dapibus vel faucibus at, posue re id enim. Nulla tincidunt felis id lectus convallis vulputate. Phasellus liber o dui, posuere sollicitudin egestas eget, blandit in urna. Sed cursus tellus sed diam hendrerit pulvinar. </p> <p jstcache="0"> Nam tincidunt mollis aliquam. Su spendisse bibendum dignissim dui, ac mollis ligula fringilla sit amet. Pellentes que dapibus lobortis dignissim. Cras eu lorem a ligula imperdiet ultricies. Phas ellus ipsum mi, accumsan quis dignissim eu, commodo ut mi. Nulla sagittis alique t malesuada. Ut lobortis tellus vitae dolor venenatis eu ullamcorper lorem gravi da. Quisque non pharetra velit. Maecenas elit risus, ultricies in sagittis eget, facilisis sed neque. Quisque feugiat porta pharetra. Vestibulum lorem magna, pe llentesque et mattis sit amet, euismod et dui. </p></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#meth ods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all func tions --> <div class="apiItem" jsselect="functions" jstcache="4"> <a jsvalues=". name:'method-' + name" jstcache="6"></a> <!-- method-anchor --> <h3 jscontent="n ame" jstcache="7">method name</h3> <div class="summary" jstcache="0"><span jsdis play="returns" jscontent="returns.typeName" jstcache="9">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="10">chr ome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optiona l ? 'optional' : ''" jstcache="11"><span jsdisplay="$index" jstcache="19">, </sp an><span jscontent="typeName" jstcache="20"></span> <var jstcache="0"><span jsco ntent="name" jstcache="7"></span></var></span>)</div> <div class="description" j stcache="0"> <p class="todo" jsdisplay="!description" jstcache="12">Undocumented .</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="13" > A description from the json schema def of the function goes here. </p> <!-- PA RAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="p arameters" jstcache="21"> <dt jstcache="0"> <!-- Note: intentionally longer 80 c olumns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache="28">optional </span><span jscontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay ="$this.description" jsvalues=".innerHTML:$this.description" jstcache="24"> Desc ription of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_ propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 8 0 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0" > (<span class="optional" jsdisplay="optional" jstcache="28">optional </span><sp an jscontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="to do" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisp lay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="24"> D escription of this parameter from the json schema. </dd> </div> </dl> </dd> </di v> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="14">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="22"> <dt jstcache="0"> <!-- Not e: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramN ame</var> <em jstcache="0">(<span jscontent="typeName" jstcache="20">paramType</ span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$thi s.description" jstcache="24"> Description of this parameter from the json schema . </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache=" 7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional </span><span jscontent="typeName" jstcache="20">paramTyp e</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="2 3"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$ this.description" jstcache="24"> Description of this parameter from the json sch ema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay= "callbackParameters" jstcache="15"> <h4 jstcache="0">Callback function</h4> <p j stcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it sho uld specify a function that looks like this: </p> <!-- Note: intentionally longe r 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="26">Type param1, Type param2</span>) <span class="subdued" jstcache="0 ">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstc ache="27"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span jscontent ="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdispla y="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.d escription" jsvalues=".innerHTML:$this.description" jstcache="24"> Description o f this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdi splay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyL ist" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional </span><span jscont ent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdis play="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$thi s.description" jsvalues=".innerHTML:$this.description" jstcache="24"> Descriptio n of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGro up --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name=" #events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterate s over all events --> <div jsselect="events" class="apiItem" jstcache="5"> <a js values=".name:'event-' + name" jstcache="8"></a> <h3 jscontent="name" jstcache=" 7">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally l onger 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span> <span jscontent="name" jstcache="7">onEvent</span><span class="subdued" jstcache ="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="16"> Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span> ); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!des cription" jstcache="12">Undocumented.</p> <p jsdisplay="description" jsvalues=". innerHTML:description" jstcache="13"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> < dl jstcache="0"> <div jsselect="parameters" jstcache="21"> <dt jstcache="0"> <!- - Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">p aramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="20">paramT ype</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache= "23">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$ this.description" jstcache="24"> Description of this parameter from the json sch ema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25 "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache=" 0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcach e="7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="option al" jstcache="28">optional </span><span jscontent="typeName" jstcache="20">param Type</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache ="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTM L:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!- - /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcac he="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automa tically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </b ody></html> 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mecha nism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is gener eated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTM L is also generated by an offline step so that this page may easily be indexed b y search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes t he single version of page template shell and the "instance" pages (bookmarks.htm l, etc...) can be generated with a build step. --><!-- <html> must retain id="te mplate --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> da ta is significant and loads the needed libraries and styles --><head jstcache="0 "> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache=" 0"> <title jscontent="pageTitle" jstcache="1">Devguide</title> <link href="css/A piRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="te xt/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstc ache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js " jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" js tcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body jstcache="0"> <div id="container" js tcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHe ader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id=" breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Exten sions</a> &gt; <a href="reference_index.html" jstcache="0">Reference</a> &gt; <a href="api_index.html" jstcache="0">chrome.* APIs</a> &gt; <span jscontent="h1He ader" jstcache="2">Devguide</span> </div> <div id="searchbox" jstcache="0"> <for m action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstc ache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtn o" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <inp ut type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" v alue="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="h ttp://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript " jstcache="0">google.load("elements", "1", {packages: "transliteration"});</scr ipt> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?for m=cse-search-box&amp;t13n_langs=en" jstcache="0"></script> <script type="text/ja vascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&amp;lang =en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jsconte nt="h1Header" jstcache="2">Devguide</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a>< /li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></l i> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html " jstcache="0">Manifest</a> </li><li jstcache="0"><a href="toolstrip.html" jstca che="0">Toolstrips</a> </li><li jstcache="0"><a href="pageActions.html" jstcache ="0">Page actions</a> </li><li jstcache="0"><a href="background_pages.html" jstc ache="0">Background pages</a> </li><li jstcache="0"><a href="content_scripts.htm l" jstcache="0">Content scripts</a> </li><li jstcache="0"><a href="extension.htm l" jstcache="0">Extension</a> </li><li jstcache="0"><a href="tabs.html" jstcache ="0">Tabs</a> </li><li jstcache="0"><a href="windows.html" jstcache="0">Windows< /a> </li><li jstcache="0"><a href="self.html" jstcache="0">Self</a> </li><li jst cache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a> </li><li jstcache= "0"><a href="packaging.html" jstcache="0">Packaging</a> </li><li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a> </li></ul> </li><li jstcache ="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1] </li><li jstcache="0" >[sample 2] </li></ul> </li></ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3" style ="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache= "0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstc ache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jst cache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li > <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0" > <li jsselect="functions" jstcache="4"> <a jscontent="name" jsvalues=".href:'#m ethod-' + name" href="#method-anchor" jstcache="17">methodName</a> </li> </ol> < /li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0 "> <li jsselect="events" jstcache="5"> <a jscontent="name" jsvalues=".href:'#eve nt-' + name" href="#event-anchor" jstcache="18">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#st ructs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href ="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: l inks to all h2s and h3s should go here -- would it be possible to link to overvi ew h3s, as well? if so, how should we create their anchor/id values?] </div> <!- - /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" js tcache="0"><p jstcache="0"> [PENDING: intro to the guide goes here. say where to go. lots o' links.] </p> <p jstcache="0"> Lorem ipsum dolor sit amet, consectet ur adipiscing elit. Fusce sed elit felis. Vestibulum porta mauris eget mi placer at a condimentum leo semper. Ut scelerisque, ipsum in cursus semper, lectus enim molestie ante, a porttitor dolor neque sit amet lorem. Integer dignissim gravid a eros ac rhoncus. Curabitur porttitor hendrerit dolor nec aliquam. Ut vulputate ultrices eros eu ultrices. Pellentesque tempor mattis odio in blandit. Proin nu lla metus, tristique eget iaculis gravida, varius at leo. Ut dolor mi, auctor et scelerisque vitae, volutpat eleifend magna. Pellentesque habitant morbi tristiq ue senectus et netus et malesuada fames ac turpis egestas. Morbi ut risus nec ma ssa consectetur accumsan sed non est. Fusce ornare eros et felis dignissim conva llis. Maecenas condimentum purus eget nisl condimentum vitae ornare diam sollici tudin. Nulla et dictum ante. In lacus odio, dapibus vel faucibus at, posuere id enim. Nulla tincidunt felis id lectus convallis vulputate. Phasellus libero dui, posuere sollicitudin egestas eget, blandit in urna. Sed cursus tellus sed diam hendrerit pulvinar. </p> <p jstcache="0"> Nam tincidunt mollis aliquam. Suspendi sse bibendum dignissim dui, ac mollis ligula fringilla sit amet. Pellentesque da pibus lobortis dignissim. Cras eu lorem a ligula imperdiet ultricies. Phasellus ipsum mi, accumsan quis dignissim eu, commodo ut mi. Nulla sagittis aliquet male suada. Ut lobortis tellus vitae dolor venenatis eu ullamcorper lorem gravida. Qu isque non pharetra velit. Maecenas elit risus, ultricies in sagittis eget, facil isis sed neque. Quisque feugiat porta pharetra. Vestibulum lorem magna, pellente sque et mattis sit amet, euismod et dui. </p></div> <!-- API PAGE --> <div class ="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <!-- M ETHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" j stcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="4"> <a jsvalues=".name:' method-' + name" jstcache="6"></a> <!-- method-anchor --> <h3 jscontent="name" j stcache="7">method name</h3> <div class="summary" jstcache="0"><span jsdisplay=" returns" jscontent="returns.typeName" jstcache="9">void</span> <!-- Note: intent ionally longer 80 columns --> <span jscontent="fullName" jstcache="10">chrome.mo dule.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'o ptional' : ''" jstcache="11"><span jsdisplay="$index" jstcache="19">, </span><sp an jscontent="typeName" jstcache="20"></span> <var jstcache="0"><span jscontent= "name" jstcache="7"></span></var></span>)</div> <div class="description" jstcach e="0"> <p class="todo" jsdisplay="!description" jstcache="12">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="13"> A de scription from the json schema def of the function goes here. </p> <!-- PARAMETE RS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="paramet ers" jstcache="21"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional </span><span jscont ent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdis play="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$thi s.description" jsvalues=".innerHTML:$this.description" jstcache="24"> Descriptio n of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd j sdisplay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_proper tyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 colu mns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<sp an class="optional" jsdisplay="optional" jstcache="28">optional </span><span jsc ontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" js display="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$ this.description" jsvalues=".innerHTML:$this.description" jstcache="24"> Descrip tion of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </d l> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="14">Returns</h4> <dl jstca che="0"> <div jsselect="returns" jstcache="22"> <dt jstcache="0"> <!-- Note: int entionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</v ar> <em jstcache="0">(<span jscontent="typeName" jstcache="20">paramType</span>) </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undoc umented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.desc ription" jstcache="24"> Description of this parameter from the json schema. </dd > <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl js tcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">par amName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstca che="28">optional </span><span jscontent="typeName" jstcache="20">paramType</spa n>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Un documented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.d escription" jstcache="24"> Description of this parameter from the json schema. < /dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbac kParameters" jstcache="15"> <h4 jstcache="0">Callback function</h4> <p jstcache= "0"> If you specify the <em jstcache="0">callback</em> parameter, it should spec ify a function that looks like this: </p> <!-- Note: intentionally longer 80 col umns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache ="26">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}< /span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="27 "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jsconte nt="name" jstcache="7">paramName</var><em jstcache="0"> (<span jscontent="typeNa me" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$thi s.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.descripti on" jsvalues=".innerHTML:$this.description" jstcache="24"> Description of this p arameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_ propertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jst cache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <va r jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="o ptional" jsdisplay="optional" jstcache="28">optional </span><span jscontent="typ eName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$ this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.descri ption" jsvalues=".innerHTML:$this.description" jstcache="24"> Description of thi s parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> < /div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> < !-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over a ll events --> <div jsselect="events" class="apiItem" jstcache="5"> <a jsvalues=" .name:'event-' + name" jstcache="8"></a> <h3 jscontent="name" jstcache="7">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span js content="name" jstcache="7">onEvent</span><span class="subdued" jstcache="0">.ad dListener</span>(function(<span jscontent="callSignature" jstcache="16">Type par am1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div > <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description " jstcache="12">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTM L:description" jstcache="13"> A description from the json schema def of the even t goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstca che="0"> <div jsselect="parameters" jstcache="21"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName </var><em jstcache="0"> (<span jscontent="typeName" jstcache="20">paramType</spa n>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23">Und ocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.des cription" jstcache="24"> Description of this parameter from the json schema. </d d> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl j stcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">pa ramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstc ache="28">optional </span><span jscontent="typeName" jstcache="20">paramType</sp an>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> U ndocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this. description" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /a piItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainC olumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></ht ml>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/content_scripts.html ('k') | chrome/common/extensions/docs/extension.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698