@@ -219,15 +219,15 @@ class IntegrationTestWidgetsFlutterBinding
219219 await _vmService.setVMTimelineFlags (streams);
220220 }
221221
222- /// Runs [action] and outputs a [vm.Timeline] trace for it.
222+ /// Runs [action] and returns a [vm.Timeline] trace for it.
223223 ///
224224 /// Waits for the `Future` returned by [action] to complete prior to stopping
225225 /// the trace.
226226 ///
227- /// `streams` limits the recorded timeline event streams to only the ones
228- /// listed. By default, all streams are recorded.
227+ /// The `streams` parameter limits the recorded timeline event streams to only
228+ /// the ones listed. By default, all streams are recorded.
229229 /// See `timeline_streams` in
230- /// https://github.com/dart-lang/sdk/blob/master/runtime/vm/timeline.cc
230+ /// [Dart-SDK/runtime/vm/timeline.cc] ( https://github.com/dart-lang/sdk/blob/master/runtime/vm/timeline.cc)
231231 ///
232232 /// If [retainPriorEvents] is true, retains events recorded prior to calling
233233 /// [action] . Otherwise, prior events are cleared before calling [action] . By
@@ -253,8 +253,16 @@ class IntegrationTestWidgetsFlutterBinding
253253 );
254254 }
255255
256- /// This is a convience wrap of [traceTimeline] and send the result back to
257- /// the host.
256+ /// This is a convenience wrap of [traceTimeline] and send the result back to
257+ /// the host for the [flutter_driver] style tests.
258+ ///
259+ /// This records the timeline during `action` and adds the result to
260+ /// [reportData] with `reportKey` .
261+ ///
262+ /// For tests with multiple calls of this method, `reportKey` needs to be a
263+ /// unique key, otherwise the later result will override earlier one.
264+ ///
265+ /// `streams` and `retainPriorEvents` are passed as-is to [traceTimeline] .
258266 Future <void > traceAction (
259267 Future <dynamic > action (), {
260268 List <String > streams = const < String > ['all' ],
0 commit comments