Add throw jsdoc

ivmartel · Jan 14, 2025 · 1e8f6ef · 1e8f6ef
1 parent a928b41
commit 1e8f6ef
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/src/image/annotationGroupFactory.js b/src/image/annotationGroupFactory.js
@@ -88,10 +88,11 @@ export class AnnotationGroupFactory {
   }
 
   /**
-   * Check dicom elements. Throws an error if not suitable.
+   * Check dicom elements.
    *
    * @param {Object<string, DataElement>} dataElements The DICOM data elements.
    * @returns {string|undefined} A possible warning.
+   * @throws Error for missing or wrong data.
    */
   checkElements(dataElements) {
     // reset
@@ -218,6 +219,7 @@ export class AnnotationGroupFactory {
    *
    * @param {Object<string, DataElement>} dataElements The DICOM tags.
    * @returns {AnnotationGroup} A new annotation group.
+   * @throws Error for missing or wrong data.
    */
   create(dataElements) {
     const annotations = [];

diff --git a/src/image/imageFactory.js b/src/image/imageFactory.js
@@ -64,10 +64,11 @@ export class ImageFactory {
   }
 
   /**
-   * Check dicom elements. Throws an error if not suitable.
+   * Check dicom elements.
    *
    * @param {DataElements} dataElements The DICOM data elements.
    * @returns {string|undefined} A possible warning.
+   * @throws Error for missing or wrong data.
    */
   checkElements(dataElements) {
     // reset
@@ -106,6 +107,7 @@ export class ImageFactory {
    *   Uint32Array | Int32Array} pixelBuffer The pixel buffer.
    * @param {number} numberOfFiles The input number of files.
    * @returns {Image} A new Image.
+   * @throws Error for missing or wrong data.
    */
   create(dataElements, pixelBuffer, numberOfFiles) {
     const size2D = getImage2DSize(dataElements);

diff --git a/src/image/maskFactory.js b/src/image/maskFactory.js
@@ -330,10 +330,11 @@ export class MaskFactory {
   }
 
   /**
-   * Check dicom elements. Throws an error if not suitable.
+   * Check dicom elements.
    *
    * @param {Object<string, DataElement>} _dicomElements The DICOM tags.
    * @returns {string|undefined} A possible warning.
+   * @throws Error for missing or wrong data.
    */
   checkElements(_dicomElements) {
     // does nothing
@@ -348,6 +349,7 @@ export class MaskFactory {
    *   Uint16Array | Int16Array |
    *   Uint32Array | Int32Array} pixelBuffer The pixel buffer.
    * @returns {Image} A new Image.
+   * @throws Error for missing or wrong data.
    */
   create(dataElements, pixelBuffer) {
     // check required and supported tags