Added comments to the MagickDefine class.

dlemstra · Aug 5, 2024 · c1ae2c1 · c1ae2c1
1 parent c027d30
commit c1ae2c1
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/src/defines/magick-define.ts b/src/defines/magick-define.ts
@@ -7,15 +7,30 @@ import { IDefine } from './define';
 import { MagickFormat } from '../enums/magick-format';
 
 export class MagickDefine implements IDefine {
+    /**
+     * Initializes a new instance of the {@link MagickDefine} class.
+     * @param format
+     * @param name The name of the define.
+     * @param value The value of the define.
+     */
     constructor(format: MagickFormat, name: string, value: string) {
         this.format = format;
         this.name = name;
         this.value = value;
     }
 
+    /**
+     * Gets the format to set the define for.
+     */
     readonly format: MagickFormat;
 
+    /**
+     * Gets the name of the define.
+     */
     readonly name: string;
 
+    /**
+     * Gets the value of the define.
+     */
     readonly value: string;
 }