Skip to content

Commit 2380567

Browse files
committed
Add the @module tag
1 parent 8c5e513 commit 2380567

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

src/index.js

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
/**
2+
* The PCUIGraph module is an extension of the PlayCanvas User Interface (PCUI) framework. It
3+
* provides a new PCUI Element type for building interactive, node-based graphs.
4+
*
5+
* Key features include:
6+
*
7+
* - Scalable and customizable node-based graphs for visualizing complex data.
8+
* - Interactive elements such as draggable nodes, clickable edges, and zoomable views.
9+
* - Easy integration within a PCUI-based user interface.
10+
*
11+
* Whether it's for displaying network topologies, process flows, or complex relational data,
12+
* PCUIGraph provides a robust and flexible solution for integrating graph visualizations into your
13+
* web projects.
14+
*
15+
* @module PCUIGraph
16+
*/
17+
118
import { deepCopyFunction } from './util.js';
219
import GraphView from './graph-view.js';
320
import { GRAPH_ACTIONS, DEFAULT_CONFIG } from './constants.js';

0 commit comments

Comments
 (0)