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

Side by Side Diff: chrome/common/extensions/docs/api_index.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">api_index</title> <link href="css/ ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="t ext/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jst cache="0"> </script> <script type="text/javascript" src="js/api_page_generator.j s" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" j stcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body class="" jstcache="0"> <div id="con tainer" 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" jstcache="0">Google Ch rome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</ a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscon tent="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0 "> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <d iv jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_ cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0 "> <input type="text" name="q" size="31" jstcache="0"> <input 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/jav ascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"} );</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t 13n?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&a mp;lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="3">api_index</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstca che="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" jstcache="0">Develop er'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 jscontent="name" jsval ues=".href:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> < /li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActions.html">PageActi ons</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jsconten t="name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Win dows</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="3"> <a jsconte nt="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="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" sty le="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcach e="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li js tcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li j stcache="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="5"> <a jscontent="name" jsvalues=".href:' #method-' + name" href="#method-anchor" jstcache="19">methodName</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache= "0"> <li jsselect="events" jstcache="6"> <a jscontent="name" jsvalues=".href:'#e vent-' + name" href="#event-anchor" jstcache="20">eventName</a> </li> </ol> </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 hr ef="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to over view 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"><p jstcache="0"> [PENDING: links to reference doc — for example, <a href="chrome-api-index.html" jstcache="0">chrome. APIs</a> — go here.] </p> <p jstcache="0"> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce se d elit felis. Vestibulum porta mauris eget mi placerat a condimentum leo semper. Ut scelerisque, ipsum in cursus semper, lectus enim molestie ante, a porttitor dolor neque sit amet lorem. Integer dignissim gravida eros ac rhoncus. Curabitur porttitor hendrerit dolor nec aliquam. Ut vulputate ultrices eros eu ultrices. Pellentesque tempor mattis odio in blandit. Proin nulla metus, tristique eget ia culis gravida, varius at leo. Ut dolor mi, auctor et scelerisque vitae, volutpat eleifend magna. Pellentesque habitant morbi tristique senectus et netus et male suada fames ac turpis egestas. Morbi ut risus nec massa consectetur accumsan sed non est. Fusce ornare eros et felis dignissim convallis. Maecenas condimentum p urus eget nisl condimentum vitae ornare diam sollicitudin. 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 egesta s eget, blandit in urna. Sed cursus tellus sed diam hendrerit pulvinar. </p> <p jstcache="0"> Nam tincidunt mollis aliquam. Suspendisse bibendum dignissim dui, ac mollis ligula fringilla sit amet. Pellentesque dapibus lobortis dignissim. Cr as eu lorem a ligula imperdiet ultricies. Phasellus ipsum mi, accumsan quis dign issim eu, commodo ut mi. Nulla sagittis aliquet malesuada. Ut lobortis tellus vi tae dolor venenatis eu ullamcorper lorem gravida. Quisque non pharetra velit. Ma ecenas elit risus, ultricies in sagittis eget, facilisis sed neque. Quisque feug iat porta pharetra. Vestibulum lorem magna, pellentesque et mattis sit amet, eui smod et dui. </p></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefi nition" jstcache="4" style="display: none; "> <!-- 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"> <a jsvalues=".name:'method-' + name" jstcache="7 "></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns. typeName" jstcache="10">void</span> <!-- Note: intentionally longer 80 columns - -> <span jscontent="fullName" jstcache="11">chrome.module.methodName</span>(<spa n jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12 "><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jst cache="22"></span> <var jstcache="0"><span jscontent="name" jstcache="8"></span> </var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdi splay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json sch ema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Par ameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jst cache="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="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> <!-- RETURNS --> <h4 jsd isplay="returns" jstcache="15">Returns</h4> <dl jstcache="0"> <div jsselect="ret urns" jstcache="24"> <dt jstcache="0"> <!-- Note: intentionally longer 80 column s --> <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 jsdispla y="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Des cription 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" jsdisplay="optional" jstcache="31">optional </span><s pan jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="t odo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdis play="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </d iv> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="1 6"> <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"> <a jsvalues=".name:'event-' + name" j stcache="9"></a> <h3 jscontent="name" jstcache="8">event name</h3> <div class="s ummary" jstcache="0"> <!-- Note: intentionally 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>(functio n(<span jscontent="callSignature" jstcache="17">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="descriptio n" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocume nted.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache= "14"> A description from the json schema def of the event goes here. </p> <!-- P ARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect=" parameters" jstcache="23"> <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" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdi splay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIE S --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jssele ct="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally lon ger 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcach e="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </spa n><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd clas s="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd j sdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="2 7"> 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> <!-- /p ageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstca che="0"> TBD: copyright/license should be 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/api/extension_api.json ('k') | chrome/common/extensions/docs/bookmarks.html » ('j') | no next file with comments »