fix(BpmnLayouter): fix JSDoc

bpmn-io · Apr 4, 2023 · 0365dfb · 0365dfb
1 parent 7ae67c5
commit 0365dfb
Showing 1 changed file with 23 additions and 2 deletions.
diff --git a/lib/features/modeling/BpmnLayouter.js b/lib/features/modeling/BpmnLayouter.js
@@ -22,6 +22,21 @@ import {
 
 import { is } from '../../util/ModelUtil';
 
+/**
+ * @typedef {import('diagram-js/lib/util/Types').Point} Point
+ *
+ * @typedef {import('./ElementFactory').BpmnConnection} BpmnConnection
+ * @typedef {import('./ElementFactory').BpmnElement} BpmnElement
+ *
+ * @typedef { {
+ *   source?: BpmnElement;
+ *   target?: BpmnElement;
+ *   waypoints?: Point[];
+ *   connectionStart?: Point;
+ *   connectionEnd?: Point;
+ * } } LayoutConnectionHints
+ */
+
 var ATTACH_ORIENTATION_PADDING = -10,
     BOUNDARY_TO_HOST_THRESHOLD = 40;
 
@@ -43,12 +58,18 @@ var orientationDirectionMapping = {
   left: 'l'
 };
 
-
 export default function BpmnLayouter() {}
 
 inherits(BpmnLayouter, BaseLayouter);
 
-
+/**
+ * Returns waypoints of laid out connection.
+ *
+ * @param {BpmnConnection} connection
+ * @param {LayoutConnectionHints} [hints]
+ *
+ * @return {Point[]}
+ */
 BpmnLayouter.prototype.layoutConnection = function(connection, hints) {
   if (!hints) {
     hints = {};