docs: expand examples of tiff tags

blacha · Nov 26, 2023 · 08a78d7 · 08a78d7
1 parent 0b5fa07
commit 08a78d7
Showing 1 changed file with 31 additions and 4 deletions.
diff --git a/packages/core/src/const/tiff.tag.id.ts b/packages/core/src/const/tiff.tag.id.ts
@@ -172,7 +172,7 @@ export enum TiffTag {
    *
    * @example
    * ```typescript
-   * 1 // uint
+   * 1 // SampleFormat.Uint
    * ```
    */
   SampleFormat = 339,
@@ -181,26 +181,53 @@ export enum TiffTag {
    * Compression Type
    *
    * @see {@link Compression}
+   *
+   * @example
+   * ```typescript
+   * 5 // Compression.Lzw
+   * ```
    */
   Compression = 259,
 
   /**
    * Photometric interpretation
    *
    * @see {@link Photometric}
+   *
+   * @example
+   * ```typescript
+   * 2 // Photometric.Rgb
+   * ```
    */
   Photometric = 262,
 
   /** Tile width in pixels */
   TileWidth = 322,
   /** Tile height in pixels */
   TileHeight = 323,
-  /** Offsets to data tiles */
+
+  /**
+   * Offsets to data tiles
+   * `0` means the tile has no data (sparse tiff)
+   *
+   * @example
+   * ```typescript
+   * [0, 3200, 1406] // three tiles, first tile does not exist
+   * ```
+   */
   TileOffsets = 324,
-  /** Byte counts for tiles */
+  /**
+   *  Byte counts for tiles
+   *  `0 means the tile does not exist (sparse tiff)
+   *
+   * @example
+   * ```typescript
+   * [0, 3200, 1406] // three tiles, first tile does not exist
+   * ```
+   **/
   TileByteCounts = 325,
 
-  /** %JPEG table stream */
+  /** JPEG table stream */
   JpegTables = 347,
 
   StripOffsets = 273,