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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/devguide.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:
View unified diff | Download patch
« no previous file with comments | « chrome/common/extensions/docs/build/generator.html ('k') | chrome/common/extensions/docs/getstarted.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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">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 class="" jstcache="0"> <div id="cont ainer" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div i d="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chr ome Extensions</a> &gt; <a href="reference_index.html" jstcache="0">Reference</a > &gt; <a href="api_index.html" jstcache="0">chrome.* APIs</a> &gt; <span jscont ent="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0" > <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <di v jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_c vzfqtno" 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/java script" jstcache="0">google.load("elements", "1", {packages: "transliteration"}) ;</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t1 3n?form=cse-search-box&amp;t13n_langs=en" jstcache="0"></script> <script type="t ext/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&am p;lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 j scontent="h1Header" jstcache="3">devguide</h1> </div> </div> <!-- /pageHeader -- > <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcach e="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 S tarted</a></li> <li jstcache="0"> <a href="devguide.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">Extension APIs</a> <ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstance="0"> <a jscontent="name" jsvalue s=".href:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> </l i><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" js values=".href:module + '.html'" jstcache="25" href="pageActions.html">PageAction s</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jscontent= "name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Windo ws</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="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="na me" 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" 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="5"> <a jscontent="name" jsvalues=".href:'#m ethod-' + 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:'#eve nt-' + name" href="#event-anchor" jstcache="20">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="4" 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="5"> <a jsvalues=".name:' method-' + name" jstcache="7"></a> <!-- method-anchor --> <h3 jscontent="name" j stcache="8">method name</h3> <div class="summary" jstcache="0"><span jsdisplay=" returns" jscontent="returns.typeName" jstcache="10">void</span> <!-- Note: inten tionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.m odule.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? ' optional' : ''" jstcache="12"><span jsdisplay="$index" jstcache="21">, </span><s pan jscontent="typeName" jstcache="22"></span> <var jstcache="0"><span jscontent ="name" jstcache="8"></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"> A d escription from the json schema def of the function goes here. </p> <!-- PARAMET ERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parame ters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 column s --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscon tent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdi splay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$th is.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Descripti on of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_prope rtyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 col umns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<s pan class="optional" jsdisplay="optional" jstcache="31">optional </span><span js content="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" j sdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay=" $this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Descri ption of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </ dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15">Returns</h4> <dl jstc ache="0"> <div jsselect="returns" jstcache="24"> <dt jstcache="0"> <!-- Note: in tentionally 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"> Undo cumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.des cription" jstcache="27"> Description of this parameter from the json schema. </d d> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl j stcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">pa ramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstc ache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</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"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbac kParameters" jstcache="16"> <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 ="29">Type param1, 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 jsconte nt="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeNa me" jstcache="22">paramType</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"> Description of this p arameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_ propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jst cache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <va r jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="o ptional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typ eName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$ this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.descri ption" jsvalues=".innerHTML:$this.description" jstcache="27"> 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="6"> <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.bookmarks.</span><span js content="name" jstcache="8">onEvent</span><span class="subdued" jstcache="0">.ad dListener</span>(function(<span jscontent="callSignature" jstcache="17">Type par am1, 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="description" jsvalues=".innerHTM L:description" jstcache="14"> 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="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</spa n>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Und ocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.des cription" jstcache="27"> Description of this parameter from the json schema. </d d> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl j stcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">pa ramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstc ache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</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"> 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>
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>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/build/generator.html ('k') | chrome/common/extensions/docs/getstarted.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698