Bug 1589122 - Add comments to the functions called when using the shortcut keys r=canaltinova

Differential Revision: https://phabricator.services.mozilla.com/D49733

--HG--
extra : moz-landing-system : lando
This commit is contained in:
Julien Wajsberg 2019-10-22 08:13:56 +00:00
parent 75ff79ea60
commit 6ab2fdc4a0

View File

@ -127,6 +127,8 @@ async function getSymbolsFromThisBrowser(debugName, breakpadId) {
}
/**
* This function is called directly by devtools/startup/DevToolsStartup.jsm when
* using the shortcut keys to capture a profile.
* @type {() => Promise<void>}
*/
async function captureProfile() {
@ -153,6 +155,10 @@ async function captureProfile() {
Services.profiler.StopProfiler();
}
/**
* This function is only called by devtools/startup/DevToolsStartup.jsm when
* starting the profiler using the shortcut keys, through toggleProfiler below.
*/
function startProfiler() {
const {
entries,
@ -172,6 +178,8 @@ function startProfiler() {
}
/**
* This function is called directly by devtools/startup/DevToolsStartup.jsm when
* using the shortcut keys to capture a profile.
* @type {() => void}
*/
function stopProfiler() {
@ -179,6 +187,8 @@ function stopProfiler() {
}
/**
* This function is called directly by devtools/startup/DevToolsStartup.jsm when
* using the shortcut keys to start and stop the profiler.
* @type {() => void}
*/
function toggleProfiler() {