From d05296509dec5803e24adc4971bf84f3e181d556 Mon Sep 17 00:00:00 2001
From: Alan Grainger <alan.grainger@gmail.com>
Date: Wed, 30 Oct 2024 12:45:23 +0100
Subject: [PATCH] Update docs

---
 src/render.ts | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/render.ts b/src/render.ts
index f428ee1..b072f03 100644
--- a/src/render.ts
+++ b/src/render.ts
@@ -17,6 +17,13 @@ class Render {
     }
   }
 
+  /**
+   * Render a gallery page for a given SharedLink, using EJS and lightGallery.
+   *
+   * @param res - ExpressJS Response
+   * @param share - Immich `shared-link` containing the assets to show in the gallery
+   * @param [openItem] - Immediately open a lightbox to the Nth item when the gallery loads
+   */
   async gallery (res: Response, share: SharedLink, openItem?: number) {
     const items = []
     for (const asset of share.assets) {