Specifiy function param types in docs

This commit is contained in:
Samuel Attard 2016-10-13 17:30:57 +11:00
parent 7584e73d70
commit 20323e7032
No known key found for this signature in database
GPG key ID: 273DC1869D8F13EF
13 changed files with 226 additions and 133 deletions

View file

@ -33,6 +33,7 @@ The `contentTracing` module has the following methods:
### `contentTracing.getCategories(callback)`
* `callback` Function
* `categories` String[]
Get a set of category groups. The category groups can change as new code paths
are reached.
@ -86,6 +87,7 @@ before options parsed from `traceOptions` are applied on it.
* `resultFilePath` String
* `callback` Function
* `resultFilePath` String
Stop recording on all processes.
@ -130,6 +132,7 @@ Once all child processes have acknowledged the `stopMonitoring` request the
* `resultFilePath` String
* `callback` Function
* `resultFilePath`
Get the current monitoring traced data.
@ -146,6 +149,8 @@ request the `callback` will be called with a file that contains the traced data.
### `contentTracing.getTraceBufferUsage(callback)`
* `callback` Function
* `value` Number
* `percentage` Number
Get the maximum usage across processes of trace buffer as a percentage of the
full state. When the TraceBufferUsage value is determined the `callback` is