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

Unified Diff: chrome/common/extensions/docs/experimental.devtools.audits.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

« no previous file with comments | « chrome/common/extensions/docs/experimental.devtools.html ('k') | chrome/common/extensions/docs/experimental.devtools.console.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: chrome/common/extensions/docs/experimental.devtools.audits.html

diff --git a/chrome/common/extensions/docs/experimental.devtools.audits.html b/chrome/common/extensions/docs/experimental.devtools.audits.html

deleted file mode 100644

index a0ba71e104de1de1a54b391af590035d3ebf1a5b..0000000000000000000000000000000000000000

--- a/chrome/common/extensions/docs/experimental.devtools.audits.html

+++ /dev/null

@@ -1,1335 +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="../../../../third_party/json_minify/minify-sans-regexp.js">

- </script>

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

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

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

- <meta name="description" content="Documentation for the chrome.experimental.devtools.audits module, which is part of the Google Chrome extension APIs."><title>chrome.experimental.devtools.audits - Google Chrome Extensions - Google Code</title></head>

- <body> <div id="devModeWarning" class="displayModeWarning">

- You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.

- </div>

- <div id="branchWarning" class="displayModeWarning">

- <span>WARNING: This is the <span id="branchName">BETA</span> documentation.

- It may not work with the stable release of Chrome.</span>

- <select id="branchChooser">

- <option>Choose a different version...

- </option><option value="">Stable

- </option><option value="beta">Beta

- </option><option value="dev">Dev

- </option><option value="trunk">Trunk

- </option></select>

- </div>

- <div id="unofficialWarning" class="displayModeWarning">

- <span>WARNING: This is unofficial documentation. It may not work with the

- current release of Chrome.</span>

- <button id="goToOfficialDocs">Go to the official docs</button>

- </div>

- <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" -->

-

- <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="https://www.google.com/jsapi"></script>

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

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

- <script type="text/javascript" src="https://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/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>

- </li>

- <li id="so_link">

- <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</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><a href="whats_new.html">What's New?</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="contextMenus.html">Context Menus</a></li>

- <li><a href="notifications.html">Desktop Notifications</a></li>

- <li><a href="omnibox.html">Omnibox</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>

- </ul>

- </li>

- <li>Browser Interaction

- <ul>

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

- <li><a href="cookies.html">Cookies</a></li>

- <li><a href="devtools.html">Developer Tools</a></li>

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

- <li><a href="history.html">History</a></li>

- <li><a href="management.html">Management</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="a11y.html">Accessibility</a></li>

- <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="permissions.html">Optional Permissions</a></li>

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

- </ul>

- </li>

- <li>Finishing

- <ul>

- <li><a href="hosting.html">Hosting</a></li>

- <li><a href="external_extensions.html">Other Deployment Options</a></li>

- </ul>

- </li>

- </ul>

- </li>

- <li><h2><a href="apps.html">Packaged Apps</a></h2></li>

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

- <ul>

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

- <li><a href="tut_analytics.html">Google Analytics</a></li>

- <li><a href="tut_oauth.html">OAuth</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="permission_warnings.html">Permission Warnings</a></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>

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

- <li><h2>More</h2>

- <ul>

- <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>

- <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>

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

- </ul>

- </li>

- </ul>

- </div>

- <script>

- initToggles();

- </script>

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

- <div id="pageTitle">

- <h1 class="page_title">chrome.experimental.devtools.audits</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#H2-0">Overview</a>

- <ol>

- </ol>

- </li><li>

- <a href="#H2-1">Examples</a>

- <ol>

- </ol>

- </li>

- <li>

- <a href="#apiReference">API reference: chrome.experimental.devtools.audits</a>

- <ol>

- <li>

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

- <ol>

- <li>

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

- </li>

- </ol>

- </li>

- <li>

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

- <ol>

- <li>

- <a href="#type-AuditCategory">AuditCategory</a>

- <ol>

- <li>

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

- <ol>

- <li>

- <a href="#event-AuditCategory-onAuditStarted">onAuditStarted</a>

- </li>

- </ol>

- </li>

- </ol>

- </li><li>

- <a href="#type-FormattedValue">FormattedValue</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-AuditResults">AuditResults</a>

- <ol>

- <li>

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

- <ol>

- <li>

- <a href="#method-AuditResults-addResult">addResult</a>

- </li><li>

- <a href="#method-AuditResults-createResult">createResult</a>

- </li><li>

- <a href="#method-AuditResults-createSnippet">createSnippet</a>

- </li><li>

- <a href="#method-AuditResults-createURL">createURL</a>

- </li><li>

- <a href="#method-AuditResults-done">done</a>

- </li>

- </ol>

- </li>

- </ol>

- </li><li>

- <a href="#type-AuditResultNode">AuditResultNode</a>

- <ol>

- <li>

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

- <ol>

- <li>

- <a href="#method-AuditResultNode-addChild">addChild</a>

- </li>

- </ol>

- </li>

- </ol>

- </li><li>

- <a href="#type-AuditResultSeverity">AuditResultSeverity</a>

- <ol>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </div>

-

-

- <p id="classSummary">

- For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page.

- </p>

-

- <div id="static">

-<p id="classSummary">

-Use the <code>chrome.experimental.devtools.audits</code> module to add new audit

-categories to Developer Tools' Audit panel.

-</p><p>

-See <a href="experimental.devtools.html">DevTools APIs summary</a> for

-general introduction to using Developer Tools APIs.

-</p>

-<a name="H2-0"></a><h2>Overview</h2>

-<p>

-Each audit category is represented by a line on <em>Select audits to run</em>

-screen in the Audits panel. The following example adds a category named

-<em>Readability</em>:</p>

-<pre>var category = chrome.experimental.devtools.audits.addCategory("Readability", 2);

-</pre>

-<img src="images/devtools-audits-category.png" style="margin-left: 20px" width="489" height="342" alt="Extension audit category on the launch screen of Audits panel">

-<p>

-If the category's checkbox is checked, the <code>onAuditStarted</code> event of

-that category will be fired when user clicks the <em>Run</em> button.

-</p>

-<p>The event handler in your extension receives <code>AuditResults</code>

-as an argument and should add one or more results using <code>addResult()</code>

-method. This may be done asynchronously, i.e. after the handler returns. The

-run of the category is considered to be complete once the extension adds the

-number of results declared when adding the category with

-<code>addCategory()</code> or

-calls AuditResult's <code>done()</code> method.

-</p>

-<p>The results may include additional details visualized as an expandable

-tree by the Audits panel. You may build the details tree using the

-<code>createResult()</code> and <code>addChild()</code> methods. The child node

-may include specially formatted fragments created by the

-<code>auditResults.createSnippet()</code>

-and <code>auditResults.createURL()</code> methods.

-</p>

-<a name="H2-1"></a><h2>Examples</h2>

-<p>The following example adds a handler for onAuditStarted event that creates

-two audit results and populates one of them with the additional details:

-</p>

-<pre>category.onAuditStarted.addListener(function(results) {

- var details = results.createResult("Details...");

- var styles = details.addChild("2 styles with small font");

- var elements = details.addChild("3 elements with small font");

- results.addResult("Font Size (5)",

- "5 elements use font size below 10pt",

- results.Severity.Severe,

- details);

- results.addResult("Contrast",

- "Text should stand out from background",

- results.Severity.Info);

-});

-</pre>

-<p>The audit result tree produced by the snippet above will look like this:

-</p>

-<img src="images/devtools-audits-results.png" style="margin-left: 20px" width="330" height="169" alt="Audit results example">

-<p>

-You can find more examples that use this API in

-<a href="samples.html#devtools.audits">Samples</a>.

-</p>

-

-</div>

-

- <div class="apiPage">

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

- <h2>API reference: chrome.experimental.devtools.audits</h2>

-

-

-

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

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

- <h3>Methods</h3>

-

- <div class="apiItem">

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

- <h4>addCategory</h4>

- <div class="summary"><span>AuditCategory</span>

-

- <span>chrome.experimental.devtools.audits.addCategory</span>(<span class="null"><span>string</span>

- <var><span>displayName</span></var></span><span class="null"><span>, </span><span>number</span>

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

- <div class="description">

- <p>Adds an audit category.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>displayName</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A display name for the category.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>resultCount</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>number</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The expected number of audit results in the category.</dd>

-

-

-

-

- </div>

- </dl>

-

- <h4>Returns</h4>

- <dl>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.devtools.audits.html#type-AuditCategory">AuditCategory</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

-

-

- </div>

- </div>

- </div>

-

-

-

- <div class="apiGroup">

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

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

-

- <div class="apiItem">

- <a name="type-AuditCategory"></a>

- <h4>AuditCategory</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A group of logically related audit checks.</dd>

-

-

-

- <dd>

- <div class="apiGroup">

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

- <h3>Events of AuditCategory</h3>

-

- <div class="apiItem">

- <a name="event-AuditCategory-onAuditStarted"></a>

- <h4>onAuditStarted</h4>

- <div class="summary">

-

- <span class="subdued">auditCategory.</span><span>onAuditStarted</span><span class="subdued">.addListener</span>(function(<span>AuditResults results</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>If the category is enabled, this event is fired when the audit is started. The event handler is expected to initiate execution of the audit logic that will populate the <code>results</code> collection.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>results</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.devtools.audits.html#type-AuditResults">AuditResults</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div>

- </div>

- </dd>

-

- </div>

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

- <a name="type-FormattedValue"></a>

- <h4>FormattedValue</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A value returned from one of the formatters (a URL, code snippet etc), to be passed to <code>createResult()</code> or <code>addChild()</code>. See <a href="#method-AuditResults-createSnippet"><code>createSnippet()</code></a> and <a href="#method-AuditResults-createURL"><code>createURL()</code></a>.</dd>

-

-

-

-

- </div>

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

- <a name="type-AuditResults"></a>

- <h4>AuditResults</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A collection of audit results for the current run of the audit category.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>Severity</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.devtools.audits.html#type-AuditResultSeverity">AuditResultSeverity</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A class that contains possible values for the audit result severities.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>text</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The contents of the node.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>children</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- array of <span><span>

- <span>

- <a href="experimental.devtools.audits.html#type-AuditResultNode">AuditResultNode</a>

- </span>

- </span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Children of this node.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>expanded</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Whether the node is expanded by default.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

- <dd>

- <div class="apiGroup">

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

- <h3>Methods of AuditResults</h3>

-

- <div class="apiItem">

- <a name="method-AuditResults-addResult"></a>

- <h4>addResult</h4>

- <div class="summary">

-

- <span>auditResults.addResult</span>(<span class="null"><span>string</span>

- <var><span>displayName</span></var></span><span class="null"><span>, </span><span>string</span>

- <var><span>description</span></var></span><span class="null"><span>, </span><span>AuditResultSeverity</span>

- <var><span>severity</span></var></span><span class="optional"><span>, </span><span>AuditResultNode</span>

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

- <div class="description">

- <p>Adds an audit result. The results are rendered as bulleted items under the audit category assoicated with the <code>AuditResults</code> object.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>displayName</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A concise, high-level description of the result.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>description</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A detailed description of what the displayName means.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>severity</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.devtools.audits.html#type-AuditResultSeverity">AuditResultSeverity</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>details</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <a href="experimental.devtools.audits.html#type-AuditResultNode">AuditResultNode</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A subtree that appears under the added result that may provide additional details on the violations found.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

-

- </div>

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

- <a name="method-AuditResults-createResult"></a>

- <h4>createResult</h4>

- <div class="summary"><span>AuditResultNode</span>

-

- <span>auditResults.createResult</span>(<span class="null"><span>string or FormattedValue</span>

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

- <div class="description">

- <p>Creates a result node that may be used as the <code>details</code> parameters to the <code>addResult()</code> method.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>content ...</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string or FormattedValue</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Either string or formatted values returned by one of the AuditResult formatters (a URL, a snippet etc). If multiple arguments are passed, these will be concatenated into a single node.</dd>

-

-

-

-

- </div>

- </dl>

-

- <h4>Returns</h4>

- <dl>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.devtools.audits.html#type-AuditResultNode">AuditResultNode</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

-

-

- </div>

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

- <a name="method-AuditResults-createSnippet"></a>

- <h4>createSnippet</h4>

- <div class="summary"><span>FormattedValue</span>

-

- <span>auditResults.createSnippet</span>(<span class="null"><span>string</span>

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

- <div class="description">

- <p>Render passed text as a code snippet in the Audits panel.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>text</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Snippet text.</dd>

-

-

-

-

- </div>

- </dl>

-

- <h4>Returns</h4>

- <dl>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.devtools.audits.html#type-FormattedValue">FormattedValue</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

-

-

- </div>

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

- <a name="method-AuditResults-createURL"></a>

- <h4>createURL</h4>

- <div class="summary"><span>FormattedValue</span>

-

- <span>auditResults.createURL</span>(<span class="null"><span>string</span>

- <var><span>href</span></var></span><span class="optional"><span>, </span><span>string</span>

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

- <div class="description">

- <p>Render passed value as a URL in the Audits panel.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>href</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A URL that appears as the href value on the resulting link.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>displayText</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Text that appears to the user.</dd>

-

-

-

-

- </div>

- </dl>

-

- <h4>Returns</h4>

- <dl>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.devtools.audits.html#type-FormattedValue">FormattedValue</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

-

-

- </div>

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

- <a name="method-AuditResults-done"></a>

- <h4>done</h4>

- <div class="summary">

-

- <span>auditResults.done</span>()</div>

- <div class="description">

- <p>Signals the DevTools Audits panel that the run of this category is over. The audit run also completes automatically when the number of added top-level results is equal to that declared when AuditCategory was created.</p>

-

- <dl>

- </dl>

-

- <dl>

- </dl>

-

-

- </div>

- </div>

- </div>

- </dd>

-

-

- </div>

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

- <a name="type-AuditResultNode"></a>

- <h4>AuditResultNode</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A node in the audit result tree. Displays content and may optionally have children nodes.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>expanded</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>If set, the subtree will always be expanded.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

- <dd>

- <div class="apiGroup">

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

- <h3>Methods of AuditResultNode</h3>

-

- <div class="apiItem">

- <a name="method-AuditResultNode-addChild"></a>

- <h4>addChild</h4>

- <div class="summary"><span>AuditResultNode</span>

-

- <span>auditResultNode.addChild</span>(<span class="null"><span>string or FormattedValue</span>

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

- <div class="description">

- <p>Adds a child node to this node.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>content ...</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string or FormattedValue</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Either string or formatted values returned by one of the AuditResult formatters (URL, snippet etc). If multiple arguments are passed, these will be concatenated into a single node.</dd>

-

-

-

-

- </div>

- </dl>

-

- <h4>Returns</h4>

- <dl>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.devtools.audits.html#type-AuditResultNode">AuditResultNode</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

-

-

- </div>

- </div>

- </div>

- </dd>

-

-

- </div>

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

- <a name="type-AuditResultSeverity"></a>

- <h4>AuditResultSeverity</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>This type contains possible values for a result severity. The results of different severities are distinguished by colored bullets near the result's display name.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>Info</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>Warning</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>Severe</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </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="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>

-<script src="https://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>