doc strings

Author: ecrax

app/lib/node-editor/hooks/useContextMenu.ts

@@ -12,6 +12,11 @@ import {
   useUndoHotkey,
 } from "./useShortcuts";
 
+/**
+ * Custom hook to manage context menus in a node editor.
+ * It provides handlers for pane, node, and selection context menus,
+ * as well as dimensions and visibility management.
+ */
 export function useContextMenu() {
   const [paneContextMenu, setPaneContextMenu] = useState<{
     x: number;

app/lib/node-editor/hooks/useFlow.ts

@@ -33,6 +33,10 @@ const selector = (state: {
   highlightDuplicateNodes: state.highlightDuplicateNodes,
 });
 
+/**
+ * Custom hook to manage the flow of nodes and edges in a React Flow instance.
+ * It provides handlers for node and edge changes, connections, and deletion.
+ */
 export function useFlow() {
   const { getIntersectingNodes, getNode, getNodes, getEdges } = useReactFlow();
   const { nodes, edges, setNodes, setEdges, highlightDuplicateNodes } =

app/lib/node-editor/hooks/useGameobjectSelect.ts

@@ -8,6 +8,14 @@ import { useState } from "react";
 
 import type { GameObject } from "~/lib/game/game-objects";
 
+/**
+ * Custom hook to manage game object selection in a node editor.
+ * It provides handlers for selecting, deselecting, and reordering game objects.
+ *
+ * @param items - List of game objects to select from.
+ * @param initialSelection - Initial selection of game objects.
+ * @param id - Identifier for the node being edited.
+ */
 export function useGameobjectSelect(
   items: GameObject[],
   initialSelection: GameObject[],

app/lib/node-editor/hooks/useMac.ts

@@ -1,5 +1,11 @@
 import { useEffect, useState } from "react";
 
+/**
+ * Custom hook to determine if the user's operating system is macOS.
+ * It checks the user agent string to identify macOS and excludes iOS devices.
+ *
+ * @returns {boolean} - True if the OS is macOS, false otherwise.
+ */
 const useIsMac = () => {
   const [isMac, setIsMacOS] = useState(false);