diff options
| author | nduca@chromium.org <nduca@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2013-06-19 03:31:53 +0000 |
|---|---|---|
| committer | nduca@chromium.org <nduca@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2013-06-19 03:31:53 +0000 |
| commit | f9a5c9e6e7f0959187f0a3f4cda6bdcfde0a3b9c (patch) | |
| tree | 67190aa58fac3c675c78f6b2a6722726a7f4a70e /tools/telemetry/docs/telemetry.page.block_page_measurement_results.html | |
| parent | 2919ace54733841b4858ca9e21008f5b8100b873 (diff) | |
| download | chromium_src-f9a5c9e6e7f0959187f0a3f4cda6bdcfde0a3b9c.zip chromium_src-f9a5c9e6e7f0959187f0a3f4cda6bdcfde0a3b9c.tar.gz chromium_src-f9a5c9e6e7f0959187f0a3f4cda6bdcfde0a3b9c.tar.bz2 | |
[telemetry] Initial (autogenerated) documentation plus support scripts
This makes help(telemetry) show the classes and methods we care most about.
Then, it adds ./update_docs script that autogenerates a docs/ folder using
pydoc.writedoc. Finally, it adds docs/ which contains HTML documentation on telemetry generated by update_docs.
BUG=241616
Review URL: https://chromiumcodereview.appspot.com/17150002
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@207156 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'tools/telemetry/docs/telemetry.page.block_page_measurement_results.html')
| -rw-r--r-- | tools/telemetry/docs/telemetry.page.block_page_measurement_results.html | 144 |
1 files changed, 144 insertions, 0 deletions
diff --git a/tools/telemetry/docs/telemetry.page.block_page_measurement_results.html b/tools/telemetry/docs/telemetry.page.block_page_measurement_results.html new file mode 100644 index 0000000..1c5fe72 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.block_page_measurement_results.html @@ -0,0 +1,144 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.block_page_measurement_results</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.block_page_measurement_results</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/block_page_measurement_results.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/block_page_measurement_results.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> + +<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> +<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page_measurement_results.html">telemetry.page.page_measurement_results</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>(<a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.block_page_measurement_results.html#BlockPageMeasurementResults">BlockPageMeasurementResults</a> +</font></dt></dl> +</dd> +</dl> + <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="BlockPageMeasurementResults">class <strong>BlockPageMeasurementResults</strong></a>(<a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.block_page_measurement_results.html#BlockPageMeasurementResults">BlockPageMeasurementResults</a></dd> +<dd><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a></dd> +<dd><a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a></dd> +<dd><a href="unittest.result.html#TestResult">unittest.result.TestResult</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="BlockPageMeasurementResults-DidMeasurePage"><strong>DidMeasurePage</strong></a>(self)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-__init__"><strong>__init__</strong></a>(self, output_file)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>:<br> +<dl><dt><a name="BlockPageMeasurementResults-Add"><strong>Add</strong></a>(self, trace_name, units, value, chart_name<font color="#909090">=None</font>, data_type<font color="#909090">='default'</font>)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-AddSummary"><strong>AddSummary</strong></a>(self, trace_name, units, value, chart_name<font color="#909090">=None</font>, data_type<font color="#909090">='default'</font>)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-WillMeasurePage"><strong>WillMeasurePage</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-__getitem__"><strong>__getitem__</strong></a>(self, i)</dt><dd><tt>Shorthand for self.<strong>page_results</strong>[i]</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-__len__"><strong>__len__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>:<br> +<dl><dt><strong>all_measurements_that_have_been_seen</strong></dt> +</dl> +<dl><dt><strong>page_results</strong></dt> +</dl> +<dl><dt><strong>values_for_current_page</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>:<br> +<dl><dt><a name="BlockPageMeasurementResults-AddError"><strong>AddError</strong></a>(self, page, err)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-AddErrorMessage"><strong>AddErrorMessage</strong></a>(self, page, message)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-AddFailure"><strong>AddFailure</strong></a>(self, page, err)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-AddFailureMessage"><strong>AddFailureMessage</strong></a>(self, page, message)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-AddSkip"><strong>AddSkip</strong></a>(self, page, reason)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-AddSuccess"><strong>AddSuccess</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-PrintSummary"><strong>PrintSummary</strong></a>(self)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-StartTest"><strong>StartTest</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-StopTest"><strong>StopTest</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-addSkip"><strong>addSkip</strong></a>(self, test, reason)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-addSuccess"><strong>addSuccess</strong></a>(self, test)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br> +<dl><dt><a name="BlockPageMeasurementResults-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-addError"><strong>addError</strong></a>(self, *args, **kw)</dt><dd><tt>Called when an error has occurred. 'err' is a tuple of values as<br> +returned by sys.exc_info().</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-addExpectedFailure"><strong>addExpectedFailure</strong></a>(self, test, err)</dt><dd><tt>Called when an expected failure/error occured.</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-addFailure"><strong>addFailure</strong></a>(self, *args, **kw)</dt><dd><tt>Called when an error has occurred. 'err' is a tuple of values as<br> +returned by sys.exc_info().</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-addUnexpectedSuccess"><strong>addUnexpectedSuccess</strong></a>(self, *args, **kw)</dt><dd><tt>Called when a test was expected to fail, but succeed.</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-printErrors"><strong>printErrors</strong></a>(self)</dt><dd><tt>Called by TestRunner after test run</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-startTest"><strong>startTest</strong></a>(self, test)</dt><dd><tt>Called when the given test is about to be run</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-startTestRun"><strong>startTestRun</strong></a>(self)</dt><dd><tt>Called once before any tests are executed.<br> + <br> +See startTest for a method called before each test.</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-stop"><strong>stop</strong></a>(self)</dt><dd><tt>Indicates that the tests should be aborted</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-stopTest"><strong>stopTest</strong></a>(self, test)</dt><dd><tt>Called when the given test has been run</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-stopTestRun"><strong>stopTestRun</strong></a>(self)</dt><dd><tt>Called once after all tests are executed.<br> + <br> +See stopTest for a method called after each test.</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-wasSuccessful"><strong>wasSuccessful</strong></a>(self)</dt><dd><tt>Tells whether or not this result was a success</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file |