Fix single line doc comments

2026-03-06 15:47:30 +08:00 · 2022-09-24 22:41:46 +02:00
parent 9a4d323a87
commit 7e55d41ec1
40 changed files with 2649 additions and 3008 deletions
--- a/js/template/BlueprintTemplate.js
+++ b/js/template/BlueprintTemplate.js
@@ -43,16 +43,12 @@ export default class BlueprintTemplate extends ITemplate {
            }), {}),
    }

-    /**
-    * @param {Blueprint} blueprint
-    */
+    /** @param {Blueprint} blueprint */
    constructed(blueprint) {
        blueprint.style.cssText = Object.entries(BlueprintTemplate.styleVariables).map(([k, v]) => `${k}:${v};`).join("")
    }

-    /**
-     * @param {Blueprint} blueprint
-     */
+    /** @param {Blueprint} blueprint */
    createInputObjects(blueprint) {
        return [
            new Copy(blueprint.getGridDOMElement(), blueprint),
@@ -93,11 +89,11 @@ export default class BlueprintTemplate extends ITemplate {
            <div class="ueb-viewport-overlay"></div>
            <div class="ueb-viewport-body">
                <div class="ueb-grid" style="
-                    --ueb-additional-x: ${element};
-                    --ueb-additional-y: ${element.translateY};
-                    --ueb-translate-x: ${element.translateX};
-                    --ueb-translate-y: ${element.translateY};
-                ">
+                                --ueb-additional-x: xxxxxxxxxx;
+                                --ueb-additional-y: xxxxxxxxxxxxxxxxxxxxx;
+                                --ueb-translate-x: xxxxxxxxxxxxxxxxxxxxx;
+                                --ueb-translate-y: xxxxxxxxxxxxxxxxxxxxx;
+                            ">
                    <div class="ueb-grid-content">
                        <div data-links></div>
                        <div data-nodes></div>
--- a/js/template/BoolPinTemplate.js
+++ b/js/template/BoolPinTemplate.js
@@ -1,9 +1,7 @@
 import { html } from "lit"
 import IInputPinTemplate from "./IInputPinTemplate"

-/**
- * @typedef {import("../element/PinElement").default} PinElement
- */
+/** @typedef {import("../element/PinElement").default} PinElement */

 export default class BoolPinTemplate extends IInputPinTemplate {

@@ -22,28 +20,22 @@ export default class BoolPinTemplate extends IInputPinTemplate {
        this.#input.addEventListener("change", this.onChangeHandler)
    }

-    /**
-     * @param {PinElement} pin
-     */
+    /** @param {PinElement} pin */
    cleanup(pin) {
        super.cleanup(pin)
        this.#input.removeEventListener("change", this.onChangeHandler)
    }

-    /**
-     * @param {PinElement} pin
-     */
+    /** @param {PinElement} pin */
    getInputs(pin) {
        return [this.#input.checked ? "true" : "false"]
    }

-    /**
-     * @param {PinElement} pin
-     */
+    /** @param {PinElement} pin */
    renderInput(pin) {
        if (pin.isInput()) {
            return html`
-                <input type="checkbox" class="ueb-pin-input" .checked=${pin.defaultValue == "true"} />
+                <input type="checkbox" class="ueb-pin-input" .checked=${pin.defaultValue=="true" } />
            `
        }
        return super.renderInput(pin)
--- a/js/template/ExecPinTemplate.js
+++ b/js/template/ExecPinTemplate.js
@@ -1,21 +1,16 @@
 import { html } from "lit"
 import PinTemplate from "./PinTemplate"

-/**
- * @typedef {import("../element/PinElement").default} PinElement
- */
+/** @typedef {import("../element/PinElement").default} PinElement */

 export default class ExecPinTemplate extends PinTemplate {

-    /**
-     * @param {PinElement} pin
-     */
+    /** @param {PinElement} pin */
    renderIcon(pin) {
        return html`
            <svg viewBox="-2 0 16 16">
                <path class="ueb-pin-tofill" stroke-width="1.25" stroke="white"
-                    d="M 2 1 a 2 2 0 0 0 -2 2 v 10 a 2 2 0 0 0 2 2 h 4 a 2 2 0 0 0 1.519 -0.698 l 4.843 -5.651 a 1 1 0 0 0 0 -1.302 L 7.52 1.7 a 2 2 0 0 0 -1.519 -0.698 z"
-                />
+                    d="M 2 1 a 2 2 0 0 0 -2 2 v 10 a 2 2 0 0 0 2 2 h 4 a 2 2 0 0 0 1.519 -0.698 l 4.843 -5.651 a 1 1 0 0 0 0 -1.302 L 7.52 1.7 a 2 2 0 0 0 -1.519 -0.698 z" />
            </svg>
        `
    }
--- a/js/template/IDraggableTemplate.js
+++ b/js/template/IDraggableTemplate.js
@@ -1,9 +1,7 @@
 import ITemplate from "./ITemplate"
 import MouseMoveDraggable from "../input/mouse/MouseMoveDraggable"

-/**
- * @typedef {import("../element/IDraggableElement").default} IDraggableElement
- */
+/** @typedef {import("../element/IDraggableElement").default} IDraggableElement */

 /**
 * @template {ISelectableDraggableElement} T
--- a/js/template/IFromToPositionedTemplate.js
+++ b/js/template/IFromToPositionedTemplate.js
@@ -1,8 +1,6 @@
 import ITemplate from "./ITemplate"

-/**
- * @typedef {import("../element/IFromToPositionedElement").default} IFromToPositionedElement
- */
+/** @typedef {import("../element/IFromToPositionedElement").default} IFromToPositionedElement */

 /**
 * @template {IFromToPositionedElement} T
--- a/js/template/IInputPinTemplate.js
+++ b/js/template/IInputPinTemplate.js
@@ -2,9 +2,7 @@ import { html } from "lit"
 import MouseIgnore from "../input/mouse/MouseIgnore"
 import PinTemplate from "./PinTemplate"

-/**
- * @typedef {import("../element/PinElement").default} PinElement
- */
+/** @typedef {import("../element/PinElement").default} PinElement */

 export default class IInputPinTemplate extends PinTemplate {

--- a/js/template/ITemplate.js
+++ b/js/template/ITemplate.js
@@ -5,9 +5,7 @@ import { css, html } from "lit"
 * @typedef {import("../input/IInput").default} IInput
 */

-/**
- * @template {IElement} T
- */
+/** @template {IElement} T */
 export default class ITemplate {

    static styles = css``
--- a/js/template/LinearColorPinTemplate.js
+++ b/js/template/LinearColorPinTemplate.js
@@ -35,9 +35,7 @@ export default class LinearColorPinTemplate extends IInputPinTemplate {
        ]
    }

-    /**
-     * @param {PinElement} pin
-     */
+    /** @param {PinElement} pin */
    getInputs(pin) {
        return [this.#input.dataset.linearColor]
    }
@@ -49,9 +47,7 @@ export default class LinearColorPinTemplate extends IInputPinTemplate {
    setInputs(pin, value = []) {
    }

-    /**
-     * @param {PinElement} pin
-     */
+    /** @param {PinElement} pin */
    renderInput(pin) {
        if (pin.isInput()) {
            return html`
--- a/js/template/LinkTemplate.js
+++ b/js/template/LinkTemplate.js
@@ -3,14 +3,10 @@ import Configuration from "../Configuration"
 import Utility from "../Utility"
 import IFromToPositionedTemplate from "./IFromToPositionedTemplate"

-/**
- * @typedef {import("../element/LinkElement").default} LinkElement
- */
+/** @typedef {import("../element/LinkElement").default} LinkElement */


-/**
- * @extends {IFromToPositionedTemplate<LinkElement>}
- */
+/** @extends {IFromToPositionedTemplate<LinkElement>} */
 export default class LinkTemplate extends IFromToPositionedTemplate {

    /**
@@ -107,9 +103,7 @@ export default class LinkTemplate extends IFromToPositionedTemplate {
        link.style.setProperty("--ueb-start-percentage", `${Math.round(link.startPercentage)}%`)
    }

-    /**
-     * @param {LinkElement} link
-     */
+    /** @param {LinkElement} link */
    render(link) {
        const uniqueId = "ueb-id-" + Math.floor(Math.random() * 1E12)
        return html`
@@ -120,10 +114,10 @@ export default class LinkTemplate extends IFromToPositionedTemplate {
                </g>
            </svg>
            ${link.linkMessageIcon != "" || link.linkMessageText != "" ? html`
-                <div class="ueb-link-message">
-                    <span class="${link.linkMessageIcon}"></span>
-                    <span class="ueb-link-message-text">${link.linkMessageText}</span>
-                </div>
+            <div class="ueb-link-message">
+                <span class="${link.linkMessageIcon}"></span>
+                <span class="ueb-link-message-text">${link.linkMessageText}</span>
+            </div>
            ` : html``}
        `
    }
--- a/js/template/NamePinTemplate.js
+++ b/js/template/NamePinTemplate.js
@@ -1,8 +1,6 @@
 import IInputPinTemplate from "./IInputPinTemplate"

-/**
- * @typedef {import("../element/PinElement").default} PinElement
- */
+/** @typedef {import("../element/PinElement").default} PinElement */

 export default class NamePinTemplate extends IInputPinTemplate {

@@ -31,9 +29,7 @@ export default class NamePinTemplate extends IInputPinTemplate {
        })
    }

-    /**
-     * @param {PinElement} pin
-     */
+    /** @param {PinElement} pin */
    cleanup(pin) {
        super.cleanup(pin)
        this.inputContentElements.forEach(element => {
@@ -41,9 +37,7 @@ export default class NamePinTemplate extends IInputPinTemplate {
        })
    }

-    /**
-     * @param {PinElement} pin
-     */
+    /** @param {PinElement} pin */
    getInputs(pin) {
        return this.inputContentElements.map(element => element.textContent) // textContent for performance reason
    }
--- a/js/template/NodeTemplate.js
+++ b/js/template/NodeTemplate.js
@@ -2,17 +2,13 @@ import { html } from "lit"
 import PinElement from "../element/PinElement"
 import SelectableDraggableTemplate from "./SelectableDraggableTemplate"

-/**
- * @typedef {import("../element/NodeElement").default} NodeElement
- */
+/** @typedef {import("../element/NodeElement").default} NodeElement */

 export default class NodeTemplate extends SelectableDraggableTemplate {

    toggleAdvancedDisplayHandler

-    /**
-     * @param {NodeElement} node
-     */
+    /** @param {NodeElement} node */
    render(node) {
        return html`
            <div class="ueb-node-border">
@@ -23,8 +19,7 @@ export default class NodeTemplate extends SelectableDraggableTemplate {
                                <svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
                                    <path
                                        d="M9.72002 6.0699C9.88111 4.96527 10.299 3.9138 10.94 2.99991C10.94 2.99991 10.94 3.05991 10.94 3.08991C10.94 3.36573 11.0496 3.63026 11.2446 3.8253C11.4397 4.02033 11.7042 4.12991 11.98 4.12991C12.2558 4.12991 12.5204 4.02033 12.7154 3.8253C12.9105 3.63026 13.02 3.36573 13.02 3.08991C13.0204 2.90249 12.9681 2.71873 12.8691 2.5596C12.7701 2.40047 12.6283 2.27237 12.46 2.18991H12.37C11.8725 2.00961 11.3275 2.00961 10.83 2.18991C9.21002 2.63991 8.58002 4.99991 8.58002 4.99991L8.40002 5.1199H5.40002L5.15002 6.1199H8.27002L7.27002 11.4199C7.11348 12.0161 6.79062 12.5555 6.33911 12.9751C5.8876 13.3948 5.32607 13.6773 4.72002 13.7899C4.78153 13.655 4.81227 13.5081 4.81002 13.3599C4.81002 13.0735 4.69624 12.7988 4.4937 12.5962C4.29116 12.3937 4.01646 12.2799 3.73002 12.2799C3.44359 12.2799 3.16889 12.3937 2.96635 12.5962C2.76381 12.7988 2.65002 13.0735 2.65002 13.3599C2.66114 13.605 2.75692 13.8386 2.92104 14.021C3.08517 14.2033 3.30746 14.3231 3.55002 14.3599C7.91002 15.1999 8.55002 11.4499 8.55002 11.4499L9.55002 7.05991H12.55L12.8 6.05991H9.64002L9.72002 6.0699Z"
-                                        fill="currentColor"
-                                    />
+                                        fill="currentColor" />
                                </svg>
                            </span>
                            <span class="ueb-node-name-text">
@@ -37,21 +32,15 @@ export default class NodeTemplate extends SelectableDraggableTemplate {
                        <div class="ueb-node-outputs"></div>
                    </div>
                    ${node.enabledState?.toString() == "DevelopmentOnly" ? html`
-                        <div class="ueb-node-developmentonly">Development Only</div>
+                    <div class="ueb-node-developmentonly">Development Only</div>
                    ` : html``}
                    ${node.advancedPinDisplay ? html`
-                        <div class="ueb-node-expansion" @click="${this.toggleAdvancedDisplayHandler}">
-                            <svg
-                                xmlns="http://www.w3.org/2000/svg"
-                                width="16"
-                                height="16"
-                                fill="currentColor"
-                                class="ueb-node-expansion-icon"
-                                viewBox="4 4 24 24"
-                            >
-                                <path d="M 16.003 18.626 l 7.081 -7.081 L 25 13.46 l -8.997 8.998 -9.003 -9 1.917 -1.916 z" />
-                            </svg>
-                        </div>
+                    <div class="ueb-node-expansion" @click="${this.toggleAdvancedDisplayHandler}">
+                        <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor"
+                            class="ueb-node-expansion-icon" viewBox="4 4 24 24">
+                            <path d="M 16.003 18.626 l 7.081 -7.081 L 25 13.46 l -8.997 8.998 -9.003 -9 1.917 -1.916 z" />
+                        </svg>
+                    </div>
                    ` : html``}
                </div>
            </div>
--- a/js/template/PinTemplate.js
+++ b/js/template/PinTemplate.js
@@ -13,9 +13,7 @@ export default class PinTemplate extends ITemplate {

    static styles = css``

-    /**
-     * @param {PinElement} pin
-     */
+    /** @param {PinElement} pin */
    connectedCallback(pin) {
        super.connectedCallback(pin)
        pin.nodeElement = pin.closest("ueb-node")
@@ -34,9 +32,7 @@ export default class PinTemplate extends ITemplate {
        ]
    }

-    /**
-     * @param {PinElement} pin
-     */
+    /** @param {PinElement} pin */
    render(pin) {
        const icon = html`
            <div class="ueb-pin-icon">
@@ -66,9 +62,7 @@ export default class PinTemplate extends ITemplate {
        `
    }

-    /**
-     * @param {PinElement} pin
-     */
+    /** @param {PinElement} pin */
    renderInput(pin) {
        return html``
    }
@@ -83,9 +77,7 @@ export default class PinTemplate extends ITemplate {
        pin.clickableElement = pin
    }

-    /**
-     * @param {PinElement} pin
-     */
+    /** @param {PinElement} pin */
    getLinkLocation(pin) {
        const rect = pin.querySelector(".ueb-pin-icon").getBoundingClientRect()
        const location = Utility.convertLocation(
--- a/js/template/RealPinTemplate.js
+++ b/js/template/RealPinTemplate.js
@@ -1,9 +1,7 @@
 import IInputPinTemplate from "./IInputPinTemplate"
 import Utility from "../Utility"

-/**
- * @typedef {import("../element/PinElement").default} PinElement
- */
+/** @typedef {import("../element/PinElement").default} PinElement */

 export default class RealPinTemplate extends IInputPinTemplate {

--- a/js/template/SelectableDraggableTemplate.js
+++ b/js/template/SelectableDraggableTemplate.js
@@ -2,9 +2,7 @@ import IDraggableTemplate from "./IDraggableTemplate"
 import ITemplate from "./ITemplate"
 import MouseMoveNodes from "../input/mouse/MouseMoveNodes"

-/**
- * @typedef {import("../element/ISelectableDraggableElement").default} ISelectableDraggableElement
- */
+/** @typedef {import("../element/ISelectableDraggableElement").default} ISelectableDraggableElement */

 /**
 * @template {ISelectableDraggableElement} T
--- a/js/template/SelectorTemplate.js
+++ b/js/template/SelectorTemplate.js
@@ -1,8 +1,6 @@
 import IFromToPositionedTemplate from "./IFromToPositionedTemplate"

-/**
- * @typedef {import("../element/SelectorElement").default} SelectorElement
- */
+/** @typedef {import("../element/SelectorElement").default} SelectorElement */

 export default class SelectorTemplate extends IFromToPositionedTemplate {