mirror of
https://github.com/google/blockly.git
synced 2026-01-09 01:50:11 +01:00
037eb59b89
* chore: add linting for tsdoc * chore: don't require types on return * chore: remove redundant fileoverview from ts * chore: change return to returns and add some newlines * chore: remove license tag * chore: don't require params/return docs * chore: remove spurious struct tags * Revert "chore: change return to returns and add some newlines" This reverts commitd6d8656a45. * chore: don't auto-add param names * chore: disable require-param bc it breaks on this * return to returns and add line breaks * chore: configure additional jsdoc rules * chore: run format * Revert "chore: remove license tag" This reverts commit173455588a. * chore: allow license tag format * chore: only require jsdoc on exported items * chore: add missing jsdoc or silence where needed * chore: run format * chore: lint fixes
62 lines
1.7 KiB
TypeScript
62 lines
1.7 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2021 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Block rendering debugging functionality.
|
|
*
|
|
* @namespace Blockly.blockRendering.debug
|
|
*/
|
|
import * as goog from '../../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.blockRendering.debug');
|
|
|
|
import * as deprecation from '../../utils/deprecation.js';
|
|
|
|
|
|
/** Whether or not the debugger is turned on. */
|
|
let useDebugger = false;
|
|
/**
|
|
* Returns whether the debugger is turned on.
|
|
*
|
|
* @returns Whether the debugger is turned on.
|
|
* @alias Blockly.blockRendering.debug.isDebuggerEnabled
|
|
* @internal
|
|
*/
|
|
export function isDebuggerEnabled(): boolean {
|
|
return useDebugger;
|
|
}
|
|
|
|
/**
|
|
* Turn on the blocks debugger.
|
|
*
|
|
* @alias Blockly.blockRendering.debug.startDebugger
|
|
* @deprecated March 2022. Use the rendering debugger in @blockly/dev-tools.
|
|
* See https://www.npmjs.com/package/@blockly/dev-tools for more information.
|
|
* @internal
|
|
*/
|
|
export function startDebugger() {
|
|
deprecation.warn(
|
|
'Blockly.blockRendering.debug.startDebugger()', 'February 2022',
|
|
'September 2022',
|
|
'the debug renderer in @blockly/dev-tools (See https://www.npmjs.com/package/@blockly/dev-tools.)');
|
|
useDebugger = true;
|
|
}
|
|
|
|
/**
|
|
* Turn off the blocks debugger.
|
|
*
|
|
* @alias Blockly.blockRendering.debug.stopDebugger
|
|
* @deprecated March 2022. Use the rendering debugger in @blockly/dev-tools.
|
|
* See https://www.npmjs.com/package/@blockly/dev-tools for more information.
|
|
* @internal
|
|
*/
|
|
export function stopDebugger() {
|
|
deprecation.warn(
|
|
'Blockly.blockRendering.debug.stopDebugger()', 'February 2022',
|
|
'September 2022',
|
|
'the debug renderer in @blockly/dev-tools (See https://www.npmjs.com/package/@blockly/dev-tools.)');
|
|
useDebugger = false;
|
|
}
|