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

Side by Side Diff: chrome/common/extensions/docs/self.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.self API Reference</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_ 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 completely g enerated. Do not edit, as it will be and rewritten. --><body class="" jstcache=" 0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcac he="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache ="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="namespace" jstcache="2">null</span> </div> <div id="search box" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670 403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UT F-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input ty pe="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type=" text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <scrip t type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "t ransliteration"});</script> <script type="text/javascript" src="http://www.googl e.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/brand?form= cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" js tcache="0"> <h1 jscontent="h1Header" jstcache="3">chrome.self</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <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="getstarted.html " jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="devguide.html" js tcache="0">Developer's Guide</a></li> <li jstcache="0"> Reference <ul jstcache=" 0"> <li jstcache="0"> <a href="api_index.html" jstcache="0">Extension APIs</a> < ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstance="0"> <a jsco ntent="name" jsvalues=".href:module + '.html'" jstcache="25" href="bookmarks.htm l">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActi ons.html">PageActions</a> </li><li jsselect="apiModules" jstcache="18" jsinstanc e="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href= "windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="18" jsinstan ce="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href ="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="* 4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="se lf.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></li> <li jstcach e="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <l i jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <l i jsselect="functions" jstcache="5" jsinstance="0"> <a jscontent="name" jsvalue s=".href:'#method-' + name" href="#method-getViews" jstcache="19">getViews</a> < /li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6" jsinstance="0" style="display : none; "> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-an chor" jstcache="20">eventName</a> </li> </ol> </li> <!-- TODO: What do we do abo ut structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: St ructs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s shou ld 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="static" jstcache="0"><!-- BEGIN AUTHOR ED CONTENT --> <p class="todo" jstcache="0"> [PENDING: API Module Overview Goes Here] </p> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="ap iPage" jsselect="apiDefinition" jstcache="4"> <!-- METHODS --> <div class="apiGr oup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstcach e="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jss elect="functions" jstcache="5" jsinstance="0"> <a jsvalues=".name:'method-' + n ame" jstcache="7" name="method-getViews"></a> <!-- method-anchor --> <h3 jsconte nt="name" jstcache="8">getViews</h3> <div class="summary" jstcache="0"><span jsd isplay="returns" jscontent="returns.typeName" jstcache="10">array of object</spa n> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jst cache="11">chrome.self.getViews</span>(<span jsselect="parameters" jsvalues="cla ss:optional ? 'optional' : ''" jstcache="12" jsinstance="0" style="display: non e; "><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22"></span> <var jstcache="0"><span jscontent="name" jstcache="8"></sp an></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" j sdisplay="!description" jstcache="13" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14">Retur ns an array of the global JavaScript objects for each of the views running insid e the current extension. This includes toolstrips, background pages, and tabs.</ p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div j sselect="parameters" jstcache="23" jsinstance="0" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="nam e" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdispl ay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache= "22">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 the json schema. </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" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdi splay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcac he="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descript ion" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalu es=".innerHTML:$this.description" jstcache="27"> Description of this parameter f rom the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15">Returns</h4> <dl jstcache="0"> <div jsselect=" returns" jstcache="24"> <dt jstcache="0"> <!-- Note: intentionally longer 80 col umns --> <var jscontent="name" jstcache="8"><!--framePath //<!--frame0--&g t;--></var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">array of object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jst cache="26" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.des cription" jsvalues=".innerHTML:$this.description" jstcache="27">Array of HTMLWin dow objects</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcac he="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span clas s="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent= "typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay ="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.de scription" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="displa y: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you spec ify the <em jstcache="0">callback</em> parameter, it should specify a function t hat looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre js tcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param 1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> < dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <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=".i nnerHTML:$this.description" jstcache="27"> Description of this parameter from th e json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" js tcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="nam e" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdispl ay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache= "22">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 the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /desc ription --> </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 all events --> <d iv jsselect="events" class="apiItem" jstcache="6" jsinstance="0" style="display : none; "> <a jsvalues=".name:'event-' + name" jstcache="9"></a> <h3 jscontent=" name" jstcache="8">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.b ookmarks.</span><span jscontent="name" jstcache="8">onEvent</span><span class="s ubdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature " jstcache="17">Type param1, Type param2</span>) <span class="subdued" jstcache= "0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="descript ion" jsvalues=".innerHTML:description" jstcache="14"> A description from the jso n schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">P arameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <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" jsvalu es=".innerHTML:$this.description" jstcache="27"> Description of this parameter f rom the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyLi st" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" > <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jsconten t="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" j sdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jst cache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descr iption" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsv alues=".innerHTML:$this.description" jstcache="27"> Description of this paramete r from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decri ption --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPag e --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFoot er" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /c ontainer --> </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/pageActions.html ('k') | chrome/common/extensions/docs/tabs.html » ('j') | no next file with comments »