chrome/common/extensions/docs/test.html - Issue 10642015: Basic setup for generating app docs

Unified Diff: chrome/common/extensions/docs/test.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 8 years, 6 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 side-by-side diff with in-line comments

Index: chrome/common/extensions/docs/test.html

diff --git a/chrome/common/extensions/docs/test.html b/chrome/common/extensions/docs/test.html

deleted file mode 100644

index 5b49843779b990779870446bfe8d9b1dfe02c24a..0000000000000000000000000000000000000000

--- a/chrome/common/extensions/docs/test.html

+++ /dev/null

@@ -1,730 +0,0 @@

-<!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 mechanism.

- 3) All <body>.innerHTML is genereated 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>.innerHTML is also generated by an offline step so that this

- page may easily be indexed by search engines.

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

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

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

- <link href="css/print.css" rel="stylesheet" type="text/css" media="print">

- <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">

- </script>

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

- <script type="text/javascript" src="js/bootstrap.js"></script>

- <title>chrome.test - Google Chrome Extensions - Google Code</title></head><body> <div id="gc-container" class="labs">

-

- <!-- In particular, sub-templates that recurse, must be used by allowing

- jstemplate to make a copy of the template in this section which

- are not operated on by way of the jsskip="true" -->

- <div style="display:none">

-

- <div id="valueTemplate">

- <dt>

- <var>paramName</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <a> Type</a>

- </span>

- <span>

- array of <span><span></span></span>

- </span>

- <span>paramType</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- <dd>

- Description of this parameter from the json schema.

- </dd>

-

- <dd>

- <dl>

- <div>

- </div>

- </dl>

- </dd>

- </div>

- </div>

- <a id="top"></a>

- <div id="skipto">

- <a href="#gc-pagecontent">Skip to page content</a>

- <a href="#gc-toc">Skip to main navigation</a>

- </div>

-

- <table id="header" width="100%" cellspacing="0" border="0">

- <tbody><tr>

- <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>

- <td valign="middle" width="100%" style="padding-left:0.6em;">

- <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">

- <div id="gsc-search-box">

- <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">

- <input type="hidden" name="ie" value="UTF-8">

- <input type="text" name="q" value="" size="55">

- <input class="gsc-search-button" type="submit" name="sa" value="Search">

- <br>

- <span class="greytext">e.g. "page action" or "tabs"</span>

- </div>

- </form>

- <script type="text/javascript" src="http://www.google.com/jsapi"></script>

- <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>

- <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>

- <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script>

- </td>

- </tr>

- </tbody></table>

- <div id="codesiteContent" class="">

- <a id="gc-topnav-anchor"></a>

- <div id="gc-topnav">

- <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>

- <ul id="home" class="gc-topnav-tabs">

- <li id="home_link">

- <a href="index.html" title="Google Chrome Extensions home page">Home</a>

- </li>

- <li id="docs_link">

- <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>

- </li>

- <li id="faq_link">

- <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>

- </li>

- <li id="samples_link">

- <a href="samples.html" title="Sample extensions (with source code)">Samples</a>

- </li>

- <li id="group_link">

- <a href="http://groups.google.com/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>

- </li>

- </ul>

- </div>

- <div class="g-section g-tpl-170">

-

- <div class="g-unit g-first" id="gc-toc">

- <ul>

- <li><a href="getstarted.html">Getting Started</a></li>

- <li><a href="overview.html">Overview</a></li>

- <li><h2><a href="devguide.html">Developer's Guide</a></h2>

- <ul>

- <li>Browser UI

- <ul>

- <li><a href="browserAction.html">Browser Actions</a></li>

- <li><a href="options.html">Options Pages</a></li>

- <li><a href="override.html">Override Pages</a></li>

- <li><a href="pageAction.html">Page Actions</a></li>

- <li><a href="themes.html">Themes</a></li>

- </ul>

- </li>

- <li>Browser Interaction

- <ul>

- <li><a href="bookmarks.html">Bookmarks</a></li>

- <li><a href="events.html">Events</a></li>

- <li><a href="tabs.html">Tabs</a></li>

- <li><a href="windows.html">Windows</a></li>

- </ul>

- </li>

- <li>Implementation

- <ul>

- <li><a href="background_pages.html">Background Pages</a></li>

- <li><a href="content_scripts.html">Content Scripts</a></li>

- <li><a href="xhr.html">Cross-Origin XHR</a></li>

- <li><a href="i18n.html">Internationalization</a></li>

- <li><a href="messaging.html">Message Passing</a></li>

- <li><a href="npapi.html">NPAPI Plugins</a></li>

- </ul>

- </li>

- <li>Finishing

- <ul>

- <li><a href="autoupdate.html">Autoupdating</a></li>

- <li><a href="packaging.html">Packaging</a></li>

- <li><a href="external_extensions.html">External Extensions</a></li>

- </ul>

- </li>

- </ul>

- </li>

- <li><h2><a href="tutorials.html">Tutorials</a></h2>

- <ul>

- <li><a href="tut_debugging.html">Debugging</a></li>

- </ul>

- </li>

- <li><h2>Reference</h2>

- <ul>

- <li>Formats

- <ul>

- <li><a href="manifest.html">Manifest Files</a></li>

- <li><a href="match_patterns.html">Match Patterns</a></li>

-

- </ul>

- </li>

- <li><a href="api_index.html">chrome.* APIs</a></li>

- <li><a href="api_other.html">Other APIs</a></li>

- </ul>

- </li>

- <li><h2><a href="samples.html">Samples</a></h2></li>

- </ul>

- </div>

- <div class="g-unit" id="gc-pagecontent">

- <div id="pageTitle">

- <h1 class="page_title">chrome.test</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li style="display: none; ">

- <a>h2Name</a>

- <ol>

- <li>

- <a>h3Name</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#apiReference">API reference: chrome.test</a>

- <ol>

- <li style="display: none; ">

- <a href="#properties">Properties</a>

- <ol>

- <li>

- <a href="#property-anchor">propertyName</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#methods">Methods</a>

- <ol>

- <li>

- <a href="#method-log">log</a>

- </li><li>

- <a href="#method-notifyFail">notifyFail</a>

- </li><li>

- <a href="#method-notifyPass">notifyPass</a>

- </li><li>

- <a href="#method-resetQuota">resetQuota</a>

- </li>

- </ol>

- </li>

- <li style="display: none; ">

- <a href="#events">Events</a>

- <ol>

- <li>

- <a href="#event-anchor">eventName</a>

- </li>

- </ol>

- </li>

- <li style="display: none; ">

- <a href="#types">Types</a>

- <ol>

- <li>

- <a href="#id-anchor">id</a>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </div>

-

-

- <div id="static"></div>

-

- <div class="apiPage">

- <a name="apiReference"></a>

- <h2>API reference: chrome.test</h2>

-

- <div class="apiGroup" style="display: none; ">

- <a name="properties"></a>

- <h3 id="properties">Properties</h3>

- <div>

- <a></a>

- <h4>getLastError</h4>

- <div class="summary">

-

- <span>chrome.extension</span><span>lastError</span>

- </div>

- <div>

- </div>

- </div>

-

- <div class="apiGroup" id="methods">

- <a name="methods"></a>

- <h3>Methods</h3>

-

- <div class="apiItem">

- <a name="method-log"></a>

- <h4>log</h4>

- <div class="summary"><span style="display: none; ">void</span>

-

- <span>chrome.test.log</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>

- <var><span>message</span></var></span>)</div>

- <div class="description">

- <p class="todo" style="display: none; ">Undocumented.</p>

- <p>Logs a message during internal unit testing.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>message</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- <dd style="display: none; ">

- Description of this parameter from the json schema.

- </dd>

-

- <dd style="display: none; ">

- <dl>

- <div>

- </div>

- </dl>

- </dd>

- </div>

- </dl>

-

- <h4 style="display: none; ">Returns</h4>

- <dl>

- <div style="display: none; ">

- <div>

- </div>

- </dl>

-

- <div style="display: none; ">

- <div>

- <h4>Callback function</h4>

- <p>

- The callback <em>parameter</em> should specify a function

- that looks like this:

- </p>

- <p>

- If you specify the <em>callback</em> parameter, it should

- specify a function that looks like this:

- </p>

-

- <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);</pre>

- <dl>

- <div>

- </div>

- </dl>

- </div>

- </div>

- </div><div class="apiItem">

- <a name="method-notifyFail"></a>

- <h4>notifyFail</h4>

- <div class="summary"><span style="display: none; ">void</span>

-

- <span>chrome.test.notifyFail</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>

- <var><span>message</span></var></span>)</div>

- <div class="description">

- <p class="todo" style="display: none; ">Undocumented.</p>

- <p>Notify the browser process that test code running in the extension failed. This is only used for internal unit testing.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>message</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- <dd style="display: none; ">

- Description of this parameter from the json schema.

- </dd>

-

- <dd style="display: none; ">

- <dl>

- <div>

- </div>

- </dl>

- </dd>

- </div>

- </dl>

-

- <h4 style="display: none; ">Returns</h4>

- <dl>

- <div style="display: none; ">

- <div>

- </div>

- </dl>

-

- <div style="display: none; ">

- <div>

- <h4>Callback function</h4>

- <p>

- The callback <em>parameter</em> should specify a function

- that looks like this:

- </p>

- <p>

- If you specify the <em>callback</em> parameter, it should

- specify a function that looks like this:

- </p>

-

- <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);</pre>

- <dl>

- <div>

- </div>

- </dl>

- </div>

- </div>

- </div><div class="apiItem">

- <a name="method-notifyPass"></a>

- <h4>notifyPass</h4>

- <div class="summary"><span style="display: none; ">void</span>

-

- <span>chrome.test.notifyPass</span>(<span class="optional"><span style="display: none; ">, </span><span>string</span>

- <var><span>message</span></var></span>)</div>

- <div class="description">

- <p class="todo" style="display: none; ">Undocumented.</p>

- <p>Notify the browser process that test code running in the extension passed. This is only used for internal unit testing.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>message</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- <dd style="display: none; ">

- Description of this parameter from the json schema.

- </dd>

-

- <dd style="display: none; ">

- <dl>

- <div>

- </div>

- </dl>

- </dd>

- </div>

- </dl>

-

- <h4 style="display: none; ">Returns</h4>

- <dl>

- <div style="display: none; ">

- <div>

- </div>

- </dl>

-

- <div style="display: none; ">

- <div>

- <h4>Callback function</h4>

- <p>

- The callback <em>parameter</em> should specify a function

- that looks like this:

- </p>

- <p>

- If you specify the <em>callback</em> parameter, it should

- specify a function that looks like this:

- </p>

-

- <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);</pre>

- <dl>

- <div>

- </div>

- </dl>

- </div>

- </div>

- </div><div class="apiItem">

- <a name="method-resetQuota"></a>

- <h4>resetQuota</h4>

- <div class="summary"><span style="display: none; ">void</span>

-

- <span>chrome.test.resetQuota</span>(<span style="display: none; "><span>, </span><span></span>

- <var><span></span></var></span>)</div>

- <div class="description">

- <p class="todo" style="display: none; ">Undocumented.</p>

- <p>Reset all accumulated quota state for all extensions. This is only used for internal unit testing.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div style="display: none; ">

- <div>

- </div>

- </dl>

-

- <h4 style="display: none; ">Returns</h4>

- <dl>

- <div style="display: none; ">

- <div>

- </div>

- </dl>

-

- <div style="display: none; ">

- <div>

- <h4>Callback function</h4>

- <p>

- The callback <em>parameter</em> should specify a function

- that looks like this:

- </p>

- <p>

- If you specify the <em>callback</em> parameter, it should

- specify a function that looks like this:

- </p>

-

- <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);</pre>

- <dl>

- <div>

- </div>

- </dl>

- </div>

- </div>

- </div>

- </div>

-

- <div class="apiGroup" style="display: none; ">

- <a name="events"></a>

- <h3 id="events">Events</h3>

-

- <div class="apiItem">

- <a></a>

- <h4>event name</h4>

- <div class="summary">

-

- <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);

- </div>

- <div class="description">

- <p class="todo">Undocumented.</p>

- <p>

- A description from the json schema def of the event goes here.

- </p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- </div>

- </dl>

- </div>

- </div>

- </div>

-

- <div class="apiGroup" style="display: none; ">

- <a name="types.sort(sortByName)"></a>

- <h3 id="types">Types</h3>

-

- <div class="apiItem">

- <a></a>

- <h4>type name</h4>

- <div>

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- <div id="gc-footer" --="">

- <div class="text">

- <p>

- Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,

- the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons

- Attribution 3.0 License</a>, and code samples are licensed under the

- <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.

- </p>

- <p>

- </p>

-

-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>

-<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script>

-<script type="text/javascript">

- // chrome doc tracking

- try {

- var engdocs = _gat._getTracker("YT-10763712-2");

- engdocs._trackPageview();

- } catch(err) {}

- // code.google.com site-wide tracking

- try {

- _uacct="UA-18071-1";

- _uanchor=1;

- _uff=0;

- urchinTracker();

- }

- catch(e) {/* urchinTracker not available. */}

-</script>

-

- </div>

- </div>

- </div>

-</body></html>

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