Skip to content

Commit 22a899c

Browse files
committed
docs(AnnotationTool): update JSDoc comments
1 parent dcb9f77 commit 22a899c

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

packages/tools/src/tools/base/AnnotationTool.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ abstract class AnnotationTool extends AnnotationDisplayTool {
116116
}
117117

118118
static toolName;
119+
119120
// ===================================================================
120121
// Abstract Methods - Must be implemented.
121122
// ===================================================================
@@ -147,11 +148,12 @@ abstract class AnnotationTool extends AnnotationDisplayTool {
147148
/**
148149
* @abstract cancel Used to cancel the ongoing tool drawing and manipulation
149150
*
151+
* @param element - The HTML element
150152
*/
151-
abstract cancel(element: HTMLDivElement);
153+
abstract cancel(element: HTMLDivElement): void;
152154

153155
/**
154-
* handleSelectedCallback Custom callback for when a handle is selected.
156+
* @abstract handleSelectedCallback Custom callback for when a handle is selected.
155157
*
156158
* @param evt - The normalized mouse event
157159
* @param annotation - The annotation selected.
@@ -166,7 +168,7 @@ abstract class AnnotationTool extends AnnotationDisplayTool {
166168
): void;
167169

168170
/**
169-
* Custom callback for when an annotation is selected
171+
* @abstract toolSelectedCallback Custom callback for when an annotation is selected
170172
*
171173
* @param evt - The normalized mouse event
172174
* @param annotation - The `Annotation` to check.
@@ -180,7 +182,7 @@ abstract class AnnotationTool extends AnnotationDisplayTool {
180182
): void;
181183

182184
/**
183-
* Returns true if the provided canvas coordinate tool is near the annotation
185+
* @abstract isPointNearTool Returns true if the provided canvas coordinate tool is near the annotation
184186
*
185187
* @param element - The HTML element
186188
* @param annotation - The annotation to check
@@ -201,7 +203,6 @@ abstract class AnnotationTool extends AnnotationDisplayTool {
201203
/**
202204
* @virtual Event handler for Cornerstone MOUSE_MOVE event.
203205
*
204-
*
205206
* @param evt - The normalized mouse event
206207
* @param filteredAnnotations - The annotations to check for hover interactions
207208
* @returns True if the annotation needs to be re-drawn by the annotationRenderingEngine.

0 commit comments

Comments
 (0)