[vm] Add some warnings to Dart_RecordTimelineEvent.

TEST=no
Change-Id: I448901c2767c48e931dc492e000d2f01e5194ed8
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/353225
Commit-Queue: Ryan Macnak <rmacnak@google.com>
Reviewed-by: Ben Konyi <bkonyi@google.com>
Reviewed-by: Derek Xu <derekx@google.com>
This commit is contained in:
Ryan Macnak 2024-02-20 20:18:09 +00:00 committed by Commit Queue
parent 952e3b718f
commit cfe4462b28

View file

@ -367,6 +367,13 @@ typedef enum {
* |Dart_Timeline_Event_Async_Begin|, and |Dart_Timeline_Event_Async_Instant| to
* support serialization in Perfetto's proto format.
*
* The Dart VM can use various underlying recorders depending on configuration
* and operating system. Many recorders do not support all event types;
* unsupported event types are siliently dropped. Some recorders do not accept
* timestamps as input, instead implicitly using the time the event is recorded.
* For maximum compatibility, record events with the Begin and End types as they
* occur instead of using the Duration type or buffering.
*
* \param label The name of the event. Its lifetime must extend at least until
* Dart_Cleanup.
* \param timestamp0 The first timestamp of the event.