Skip to content

Commit 9f40ccd

Browse files
committed
Update IBlocklyRegistry docstrings
1 parent 0120951 commit 9f40ccd

File tree

2 files changed

+20
-28
lines changed

2 files changed

+20
-28
lines changed

packages/blockly/src/registry.ts

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -51,38 +51,35 @@ export class BlocklyRegistry implements IBlocklyRegistry {
5151
/**
5252
* Register a toolbox for the editor.
5353
*
54-
* @argument name Name of the toolbox.
54+
* @argument name The name of the toolbox.
5555
*
56-
* @argument value Toolbox to register.
56+
* @argument toolbox The toolbox to register.
5757
*/
58-
registerToolbox(name: string, value: ToolboxDefinition): void {
59-
this._toolboxes.set(name, value);
58+
registerToolbox(name: string, toolbox: ToolboxDefinition): void {
59+
this._toolboxes.set(name, toolbox);
6060
}
6161

6262
/**
6363
* Register new blocks.
6464
*
65-
* @argument blocks Blocks to register.
65+
* @argument blocks A list of block definitions to register.
6666
*/
6767
registerBlocks(blocks: BlockDefinition[]): void {
6868
Blockly.defineBlocksWithJsonArray(blocks);
6969
}
7070

7171
/**
72-
* Register new generators.
72+
* Register a new generator.
7373
*
74-
* @argument name Name of the generator.
74+
* @argument language The language output by the generator.
7575
*
76-
* @argument generator Generator to register.
76+
* @argument generator The generator to register.
7777
*
7878
* #### Notes
79-
* When registering a generator, the name should correspond to the language
80-
* used by a kernel.
81-
*
82-
* If you register a generator for an existing language this will be overwritten.
79+
* If a generator already exists for the given language it is overwritten.
8380
*/
84-
registerGenerator(name: string, generator: Blockly.Generator): void {
85-
this._generators.set(name, generator);
81+
registerGenerator(language: string, generator: Blockly.Generator): void {
82+
this._generators.set(language, generator);
8683
}
8784

8885
setlanguage(language: string): void {

packages/blockly/src/token.ts

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,33 +21,28 @@ export interface IBlocklyRegistry {
2121
/**
2222
* Register a toolbox for the editor.
2323
*
24-
* @argument name Name of the toolbox.
24+
* @argument name The name of the toolbox.
2525
*
26-
* @argument value Toolbox to register.
26+
* @argument toolbox The toolbox to register.
2727
*/
28-
registerToolbox(name: string, value: ToolboxDefinition): void;
28+
registerToolbox(name: string, toobox: ToolboxDefinition): void;
2929

3030
/**
3131
* Register new blocks.
3232
*
33-
* @argument name Name of the toolbox.
34-
*
35-
* @argument value Toolbox to register.
33+
* @argument blocks A list of block definitions to register.
3634
*/
3735
registerBlocks(blocks: BlockDefinition[]): void;
3836

3937
/**
40-
* Register new generators.
38+
* Register a new generator.
4139
*
42-
* @argument name Name of the toolbox.
40+
* @argument language The language output by the generator.
4341
*
44-
* @argument value Toolbox to register.
42+
* @argument generator The generator to register.
4543
*
4644
* #### Notes
47-
* When registering a generator, the name should correspond to the language
48-
* used by a kernel.
49-
*
50-
* If you register a generator for an existing language this will be overwritten.
45+
* If a generator already exists for the given language it is overwritten.
5146
*/
52-
registerGenerator(name: string, generator: Blockly.Generator): void;
47+
registerGenerator(language: string, generator: Blockly.Generator): void;
5348
}

0 commit comments

Comments
 (0)