chrome/common/extensions/docs/pageActions.html - Issue 159607: Extension docs build script, gyp target and PRESUBMIT.PY check

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

Issue 159607: Extension docs build script, gyp target and PRESUBMIT.PY check (Closed)

Patch Set: remove build step on mac 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:

OLD	NEW
1 <!DOCTYPE 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">chrome.pageActions API Reference</ title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcac he="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jste mplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src=" js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is compl etely generated. Do not edit, as it will be and rewritten. --><body class="" jst cache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <! -- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TO DO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" j stcache="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* AP Is</a> > <span jscontent="namespace" jstcache="2">null</span> </div> <div id= "searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-searc h-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="00 2967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" va lue="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <i nput type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packa ges: "transliteration"});</script> <script type="text/javascript" src="http://ww w.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0">< /script> <script type="text/javascript" src="http://www.google.com/coop/cse/bran d?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTi tle" jstcache="0"> <h1 jscontent="h1Header" jstcache="3">chrome.pageActions</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SID ENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a href="g etstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="dev guide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"> Reference <ul jstcache="0"> <li jstcache="0"> <a href="api_index.html" jstcache="0">Extens ion APIs</a> <ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstanc e="0"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href= "bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsin stance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache= "18" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstca che="25" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache ="18" jsinstance="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstc ache="25" href="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache ="25" href="self.html">Self</a> </li> </ul> </li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect= "apiDefinition" jstcache="4"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0" > <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></l i> <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 js tcache="0"> <li jsselect="functions" jstcache="5" jsinstance="0"> <a jscontent=" name" jsvalues=".href:'#method-' + name" href="#method-enableForTab" jstcache="1 9">enableForTab</a> </li><li jsselect="functions" jstcache="5" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-disableForT ab" jstcache="19">disableForTab</a> </li> </ol> </li> <li jstcache="0"> <a href= "#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcac he="6" jsinstance="0" style="display: none; "> <a jscontent="name" jsvalues=".h ref:'#event-' + name" href="#event-anchor" jstcache="20">eventName</a> </li> </o l> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0 "><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [P ENDING: 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?] < /div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="s tatic" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p class="todo" jstcache="0" > [PENDING: API Module Overview Goes Here] </p> <!-- END AUTHORED CONTENT --> </ div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="4 "> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#m ethods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all f unctions --> <div class="apiItem" jsselect="functions" jstcache="5" jsinstance=" 0"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-enableForTab" ></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">enableForTab</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns. typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intention ally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.pageA ctions.enableForTab</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$i ndex" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">string</span> <var jstcache="0"><span jscontent="name" jstcache="8 ">pageActionId</span></var></span><span jsselect="parameters" jsvalues="class:op tional ? 'optional' : ''" jstcache="12" jsinstance="1" class=""><span jsdisplay ="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">object </span> <var jstcache="0"><span jscontent="name" jstcache="8">action</span></var ></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay ="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsval ues=".innerHTML:description" jstcache="14" style="display: none; "> A descriptio n from the json schema def of the function goes here. </p> <!-- PARAMETERS --> < h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jst cache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">pageActionId</var><em jstcache="0 "> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: no ne; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</e m> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocume nted. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descrip tion" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propert yList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 colum ns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<spa n class="optional" jsdisplay="optional" jstcache="31">optional </span><span jsco ntent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsd isplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$t his.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Descript ion of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="1"> <dt jstcache="0"> <!-- Note : intentionally longer 80 columns --> <var jscontent="name" jstcache="8">action< /var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31 " style="display: none; ">optional </span><span jscontent="typeName" jstcache="2 2">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jst cache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".inn erHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisp lay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyLis t" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally long er 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0" > (<span class="optional" jsdisplay="optional" jstcache="31" style="display: non e; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</e m> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocume nted. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descrip tion" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinsta nce="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var j scontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" j sdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay=" $this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style=" display: none; "> Description of this parameter from the json schema. </dd> </di v><div jsselect="_propertyList" jstcache="32" jsinstance="2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8 ">title</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstc ache="31">optional </span><span jscontent="typeName" jstcache="22">string</span> )</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undo cumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.des cription" jstcache="27" style="display: none; "> Description of this parameter f rom the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsi nstance="3"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> < var jscontent="name" jstcache="8">iconId</var><em jstcache="0"> (<span class="op tional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="type Name" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$thi s.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.descripti on" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="displ ay: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 c olumns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">( <span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class= "todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsd isplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" > Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTI ES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jssel ect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally lo nger 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcac he="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </sp an><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd cla ss="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache=" 27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd > </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jst cache="16" style="display: none; "> <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="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0 ">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstc ache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent ="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdispla y="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.d escription" jsvalues=".innerHTML:$this.description" jstcache="27"> Description o f this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdi splay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyL ist" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscont ent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdis play="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$thi s.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Descriptio n of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functio ns" jstcache="5" jsinstance="1"> <a jsvalues=".name:'method-' + name" jstcache= "7" name="method-disableForTab"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">disableForTab</h3> <div class="summary" jstcache="0"><span jsdispl ay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; "> void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="full Name" jstcache="11">chrome.pageActions.disableForTab</span>(<span jsselect="para meters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, < /span><span jscontent="typeName" jstcache="22">string</span> <var jstcache="0">< span jscontent="name" jstcache="8">pageActionId</span></var></span><span jsselec t="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinsta nce="1" class=""><span jsdisplay="$index" jstcache="21">, </span><span jsconten t="typeName" jstcache="22">object</span> <var jstcache="0"><span jscontent="name " jstcache="8">action</span></var></span>)</div> <div class="description" jstcac he="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" styl e="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0 "> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <! -- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8"> pageActionId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName " jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.des cription" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" j svalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> De scription of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES - -> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstc ache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- No te: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">param Name</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcach e="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span> )</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undo cumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.des cription" jstcache="27"> Description of this parameter from the json schema. </d d> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance= "1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jsco ntent="name" jstcache="8">action</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" j sdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay=" $this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style=" display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache ="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache=" 0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcach e="8">tabId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.des cription" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" j svalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> De scription of this parameter from the json schema. </dd> </div><div jsselect="_pr opertyList" jstcache="32" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentio nally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstc ache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="disp lay: none; ">optional </span><span jscontent="typeName" jstcache="22">string</sp an>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> U ndocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this. description" jstcache="27" style="display: none; "> Description of this paramete r from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> < h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl js tcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt j stcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name " jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstc ache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descri ption" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsva lues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_property List" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="3 2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscont ent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" j stcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.des cription" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" j svalues=".innerHTML:$this.description" jstcache="27"> Description of this parame ter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK -- > <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that look s like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache=" 0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstca che="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!- - Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">p aramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramT ype</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache= "26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML :$this.description" jstcache="27"> Description of this parameter from the json s chema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache=" 28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache ="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstca che="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="opti onal" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">par amType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcac he="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerH TML:$this.description" jstcache="27"> Description of this parameter from the jso n schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div clas s="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 i d="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jssel ect="events" class="apiItem" jstcache="6" jsinstance="*0" style="display: none; "> <a jsvalues=".name:'event-' + name" jstcache="9"></a> <h3 jscontent="name" js tcache="8">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intenti onally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks .</span><span jscontent="name" jstcache="8">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcac he="17">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{... }</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdispl ay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsv alues=".innerHTML:description" jstcache="14"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameter s</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache= "0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcac he="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22 ">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" j stcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".inn erHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstc ache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt js tcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay ="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="2 2">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=". innerHTML:$this.description" jstcache="27"> Description of this parameter from t he json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription -- > </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </ div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --=" " jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should b e automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>

2 <!-- This page is a placeholder for generated extensions api doc. Note:

3 1) The <head> information in this page is significant, should be uniform

4 across api docs and should be edited only with knowledge of the

5 templating mechanism.

6 2) The <body> tag must retain id="body"

7 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a

8 browser, it will be re-generated from the template, json schema and

9 authored overview content.

10 4) The <body>.innerHTML is also generated by an offline step so that this

11 page may easily be indexed by search engines.

12

13 TODO(rafaelw): Abstract this into a "pageshell" that becomes the single

14 version of page template shell and the "instance" pages (bookmarks.html,

15 etc...) can be generated with a build step.

16 -->

17 <!-- <html> must retain id="template -->

18 <html xmlns="http://www.w3.org/1999/xhtml">

19 <!-- <head> data is significant and loads the needed libraries and styles -->

20 <head>

21 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

22 <title jscontent="pageTitle">pageTitle</title>

23 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">

24 <script type="text/javascript"

25 src="../../../third_party/jstemplate/jstemplate_compiled.js">

26 </script>

27 <script type="text/javascript" src="js/api_page_generator.js"></script>

28 <script>

29 // Re-render the page if the user-agent is chrome and it is being served as

30 // a file:/// scheme. This allows both the initial render to static as well

31 // as dynamic re-rendering for developers/doc-writers working on local changes.

32 window.onload = function() {

33 var chrome = navigator.userAgent.indexOf("Chrome") > -1;

34 var fileScheme = location.protocol == "file:";

35 var regenerate = chrome && fileScheme;

36 //if (regenerate) {

37 window.renderPage();

38 //}

39 }

40 </script>

41 </head>

42 <!-- <body> content is completely generated. Do not edit, as it will be

43 and rewritten. -->

44 <body class="hidden">

45 </body>

46 </html>

OLD	NEW

« no previous file with comments | « chrome/common/extensions/docs/overview.html ('k') | chrome/common/extensions/docs/self.html » ('j') | no next file with comments »