Documentation

Author: hbcarlos

src/layout.ts

@@ -99,6 +99,7 @@ export class BlocklyLayout extends PanelLayout {
     // Execute the code using the kernel, by using a static method from the
     // same class to make an execution request.
     if (this._sessionContext.hasNoKernel) {
+      // Check whether there is a kernel
       showErrorMessage(
         'Select a valid kernel',
         `There is not a valid kernel selected, select one from the dropdown menu in the toolbar.

src/manager.ts

@@ -10,7 +10,9 @@ import * as Blockly from 'blockly';
 import { BlocklyRegistry } from './registry';
 
 /**
- * BlocklyManager
+ * BlocklyManager the manager for each document
+ * to select the toolbox and the generator that the
+ * user wants to use on a specific document.
  */
 export class BlocklyManager {
   private _toolbox: JSONObject;
@@ -34,34 +36,64 @@ export class BlocklyManager {
     this._sessionContext.kernelChanged.connect(this._onKernelChanged, this);
   }
 
+  /**
+   * Returns the selected toolbox.
+   */
   get toolbox(): JSONObject {
     return this._toolbox;
   }
 
+  /**
+   * Returns the name of the selected kernel.
+   */
   get kernel(): string | undefined {
     return this._selectedKernel?.name || 'No kernel';
   }
 
+  /**
+   * Returns the selected generator.
+   */
   get generator(): Blockly.Generator {
     return this._generator;
   }
 
+  /**
+   * Signal triggered when the manager changes.
+   */
   get changed(): ISignal<this, BlocklyManager.Change> {
     return this._changed;
   }
 
+  /**
+   * Dispose.
+   */
   dispose(): void {
     this._sessionContext.kernelChanged.disconnect(this._onKernelChanged, this);
   }
 
+  /**
+   * Set the selected toolbox.
+   *
+   * @argument name The name of the toolbox.
+   */
   setToolbox(name: string) {
     this._toolbox = this._registry.toolboxes.get(name);
   }
 
+  /**
+   * Set the selected kernel.
+   *
+   * @argument name The name of the kernel.
+   */
   selectKernel(name: string) {
     this._sessionContext.changeKernel({ name });
   }
 
+  /**
+   * Set the selected toolbox.
+   *
+   * @returns the list of available kernels for Blockly
+   */
   listKernels(): { label: string; value: string }[] {
     const specs = this._sessionContext.specsManager.specs.kernelspecs;
     const list: { label: string; value: string }[] = [];
@@ -88,6 +120,14 @@ export class BlocklyManager {
   }
 }
 
+/**
+ * BlocklyManager the manager for each document
+ * to select the toolbox and the generator that the
+ * user wants to use on a specific document.
+ */
 export namespace BlocklyManager {
+  /**
+   * The argument of the signal manager changed.
+   */
   export type Change = 'toolbox' | 'kernel';
 }