tools/telemetry/docs/telemetry.page.actions.js_collect_garbage.html - Issue 196383034: Update telemetry docs by running the update_docs script.

Side by Side Diff: tools/telemetry/docs/telemetry.page.actions.js_collect_garbage.html

Issue 196383034: Update telemetry docs by running the update_docs script. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 6 years, 9 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 | Annotate | Revision Log

« no previous file with comments | « tools/telemetry/docs/telemetry.page.actions.click_element.html ('k') | tools/telemetry/docs/telemetry.page.actions.page_action.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
1	1

2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">	2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

3 <html><head><title>Python: module telemetry.page.actions.js_collect_garbage</tit le>	3 <html><head><title>Python: module telemetry.page.actions.js_collect_garbage</tit le>

4 </head><body bgcolor="#f0f0f8">	4 </head><body bgcolor="#f0f0f8">

5	5

6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">	6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">

7 <tr bgcolor="#7799ee">	7 <tr bgcolor="#7799ee">

8 <td valign=bottom> <br>	8 <td valign=bottom> <br>

9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.action s.html"><font color="#ffffff">actions</font></a>.js_collect_garbage</strong></bi g></big></font></td	9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.action s.html"><font color="#ffffff">actions</font></a>.js_collect_garbage</strong></bi g></big></font></td

10 ><td align=right valign=bottom	10 ><td align=right valign=bottom

(...skipping 31 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
42 <font color="#000000" face="helvetica, arial"><a name="JsCollectGarbageAction">c lass <strong>JsCollectGarbageAction</strong></a>(<a href="telemetry.page.actions .page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>) </font></td></tr>	42 <font color="#000000" face="helvetica, arial"><a name="JsCollectGarbageAction">c lass <strong>JsCollectGarbageAction</strong></a>(<a href="telemetry.page.actions .page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>) </font></td></tr>

43	43

44 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>	44 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

45 <td width="100%"><dl><dt>Method resolution order:</dt>	45 <td width="100%"><dl><dt>Method resolution order:</dt>

46 <dd><a href="telemetry.page.actions.js_collect_garbage.html#JsCollectGarbageActi on">JsCollectGarbageAction</a></dd>	46 <dd><a href="telemetry.page.actions.js_collect_garbage.html#JsCollectGarbageActi on">JsCollectGarbageAction</a></dd>

47 <dd><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page. actions.page_action.PageAction</a></dd>	47 <dd><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page. actions.page_action.PageAction</a></dd>

48 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>	48 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

49 </dl>	49 </dl>

50 <hr>	50 <hr>

51 Methods defined here:<br>	51 Methods defined here:<br>

52 <dl><dt><a name="JsCollectGarbageAction-RunAction"><strong>RunAction</strong></a >(self, page, tab, previous_action)</dt></dl>	52 <dl><dt><a name="JsCollectGarbageAction-RunAction"><strong>RunAction</strong></a >(self, page, tab)</dt></dl>

53	53

54 <dl><dt><a name="JsCollectGarbageAction-__init__"><strong>__init__</strong></a>( self, attributes<font color="#909090">=None</font>)</dt></dl>	54 <dl><dt><a name="JsCollectGarbageAction-__init__"><strong>__init__</strong></a>( self, attributes<font color="#909090">=None</font>)</dt></dl>

55	55

56 <hr>	56 <hr>

57 Methods inherited from <a href="telemetry.page.actions.page_action.html#PageActi on">telemetry.page.actions.page_action.PageAction</a>:<br>	57 Methods inherited from <a href="telemetry.page.actions.page_action.html#PageActi on">telemetry.page.actions.page_action.PageAction</a>:<br>

58 <dl><dt><a name="JsCollectGarbageAction-BindMeasurementJavaScript"><strong>BindM easurementJavaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let& nbsp;this action determine when measurements should&nbs p;start and stop.<br>	58 <dl><dt><a name="JsCollectGarbageAction-BindMeasurementJavaScript"><strong>BindM easurementJavaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let& nbsp;this action determine when measurements should&nbs p;start and stop.<br>

59  <br>	59  <br>

60 A measurement can call this method to provide  the action<br>	60 A measurement can call this method to provide  the action<br>

61 with JavaScript code that starts and stops me asurements. The action<br>	61 with JavaScript code that starts and stops me asurements. The action<br>

62 determines when to execute the provided JavaScript  code, for more accurate<br>	62 determines when to execute the provided JavaScript  code, for more accurate<br>

63 timings.<br>	63 timings.<br>

64  <br>	64  <br>

65 Args:<br>	65 Args:<br>

66   tab: The tab to do everything on.<br>	66   tab: The tab to do everything on.<br>

67   start_js: JavaScript code that starts measu rements.<br>	67   start_js: JavaScript code that starts measu rements.<br>

68   stop_js: JavaScript code that stops measure ments.</tt></dd></dl>	68   stop_js: JavaScript code that stops measure ments.</tt></dd></dl>

69	69

70 <dl><dt><a name="JsCollectGarbageAction-CanBeBound"><strong>CanBeBound</strong>< /a>(self)</dt><dd><tt>If this class implements BindMeasureme ntJavaScript, override CanBeBound<br>	70 <dl><dt><a name="JsCollectGarbageAction-CanBeBound"><strong>CanBeBound</strong>< /a>(self)</dt><dd><tt>If this class implements BindMeasureme ntJavaScript, override CanBeBound<br>

71 to return True so that a test knows it&n bsp;can bind measurements.</tt></dd></dl>	71 to return True so that a test knows it&n bsp;can bind measurements.</tt></dd></dl>

72	72

73 <dl><dt><a name="JsCollectGarbageAction-CleanUp"><strong>CleanUp</strong></a>(se lf, page, tab)</dt></dl>	73 <dl><dt><a name="JsCollectGarbageAction-CleanUp"><strong>CleanUp</strong></a>(se lf, page, tab)</dt></dl>

74	74

75 <dl><dt><a name="JsCollectGarbageAction-CustomizeBrowserOptions"><strong>Customi zeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to a dd action-specific options to the BrowserOptions<br>	75 <dl><dt><a name="JsCollectGarbageAction-CustomizeBrowserOptionsForPageSet"><stro ng>CustomizeBrowserOptionsForPageSet</strong></a>(self, options)</dt><dd><tt>Ove rride to add action-specific options to the B rowserOptions<br>

76 object.</tt></dd></dl>	76 object. These options will be set for the&nbs p;whole page set.<br>

	77  <br>

	78 If the browser is not being restarted for&nbs p;every page in the page set then<br>

	79 all browser options required for the action m ust be set here. This, however,<br>

	80 requires that they do not conflict with optio ns require by other actions<br>

	81 used up by the page set.</tt></dd></dl>

77	82

78 <dl><dt><a name="JsCollectGarbageAction-RunsPreviousAction"><strong>RunsPrevious Action</strong></a>(self)</dt><dd><tt>Some actions require some&n bsp;initialization to be performed before the<br>	83 <dl><dt><a name="JsCollectGarbageAction-GetActiveRangeOnTimeline"><strong>GetAct iveRangeOnTimeline</strong></a>(self, timeline)</dt></dl>

79 previous action. For example, wait for href c hange needs to record the old<br>	84

80 href before the previous action changes it. T herefore, we allow actions to<br>	85 <dl><dt><a name="JsCollectGarbageAction-RunActionAndMaybeWait"><strong>RunAction AndMaybeWait</strong></a>(self, page, tab)</dt></dl>

81 run the previous action. An action that does& nbsp;this should override this to<br>

82 return True in order to prevent the previous& nbsp;action from being run twice.</tt></dd></dl>

83	86

84 <dl><dt><a name="JsCollectGarbageAction-WillRunAction"><strong>WillRunAction</st rong></a>(self, page, tab)</dt><dd><tt>Override to do action-spec ific setup before<br>	87 <dl><dt><a name="JsCollectGarbageAction-WillRunAction"><strong>WillRunAction</st rong></a>(self, page, tab)</dt><dd><tt>Override to do action-spec ific setup before<br>

85 Test.WillRunAction is called.</tt></dd></dl>	88 Test.WillRunAction is called.</tt></dd></dl>

86	89

	90 <dl><dt><a name="JsCollectGarbageAction-WillWaitAfterRun"><strong>WillWaitAfterR un</strong></a>(self)</dt></dl>

	91

	92 <hr>

	93 Static methods inherited from <a href="telemetry.page.actions.page_action.html#P ageAction">telemetry.page.actions.page_action.PageAction</a>:<br>

	94 <dl><dt><a name="JsCollectGarbageAction-ResetNextTimelineMarkerId"><strong>Reset NextTimelineMarkerId</strong></a>()</dt></dl>

	95

87 <hr>	96 <hr>

88 Data descriptors inherited from <a href="telemetry.page.actions.page_action.html #PageAction">telemetry.page.actions.page_action.PageAction</a>:<br>	97 Data descriptors inherited from <a href="telemetry.page.actions.page_action.html #PageAction">telemetry.page.actions.page_action.PageAction</a>:<br>

89 <dl><dt><strong>__dict__</strong></dt>	98 <dl><dt><strong>__dict__</strong></dt>

90 <dd><tt>dictionary for instance variables (if defined)< /tt></dd>	99 <dd><tt>dictionary for instance variables (if defined)< /tt></dd>

91 </dl>	100 </dl>

92 <dl><dt><strong>__weakref__</strong></dt>	101 <dl><dt><strong>__weakref__</strong></dt>

93 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>	102 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>

94 </dl>	103 </dl>

95 </td></tr></table></td></tr></table>	104 </td></tr></table></td></tr></table>

96 </body></html>	105 </body></html>

OLD	NEW