From 92dc83240b31455b8282242fafb0471681538fbe Mon Sep 17 00:00:00 2001
From: Hsieh Chin Fan <pham@topo.tw>
Date: Mon, 28 Oct 2024 19:28:51 +0800
Subject: docs: jsdoc

---
 src/Link.mjs     |  3 +--
 src/dumbymap.mjs | 21 ++++++++++++---------
 2 files changed, 13 insertions(+), 11 deletions(-)

(limited to 'src')

diff --git a/src/Link.mjs b/src/Link.mjs
index 7947152..92aaacf 100644
--- a/src/Link.mjs
+++ b/src/Link.mjs
@@ -3,8 +3,7 @@ import { insideWindow, insideParent } from './utils'
 import * as markers from './marker.mjs'
 
 /**
- * GeoLink: anchor element with geo scheme and properties about maps
- * @typedef {Object} GeoLink
+ * @typedef {Object} GeoLink - anchor element with geo scheme and properties about maps
  * @extends HTMLAnchorElement
  * @property {string[]} targets - ids of target map elements
  * @property {LeaderLine[]} lines
diff --git a/src/dumbymap.mjs b/src/dumbymap.mjs
index aaf0ad7..f538d0d 100644
--- a/src/dumbymap.mjs
+++ b/src/dumbymap.mjs
@@ -128,19 +128,22 @@ const defaultRender = mapclay.renderWith(config => ({
  * Generates maps based on the provided configuration
  *
  * @param {HTMLElement} container - The container element for the maps
- * @param {Object} options - Configuration options
+ * @param {Object} options
+ * @param {String} options.contentSelector - CSS selector for Semantic HTML
  * @param {string} options.crs - CRS in EPSG/ESRI code, see epsg.io
- * @param {number} [options.delay=1000] - Delay before rendering maps (in milliseconds)
- * @param {Function} options.mapCallback - Callback function to be called after map rendering
+ * @param {string} options.initialLayout
+ * @param {number} [options.delay=1000] mapDelay - Delay before rendering maps (in milliseconds)
+ * @param {Function} options.render - Render function for maps
+ * @param {Function} options.renderCallback - Callback function to be called after map rendering
  */
 export const generateMaps = (container, {
+  contentSelector,
   crs = 'EPSG:4326',
   initialLayout,
   layouts = [],
   mapDelay = 1000,
-  renderCallback,
-  contentSelector,
   render = defaultRender,
+  renderCallback = () => null,
 } = {}) => {
   /** Prepare: Contaner */
   if (container.classList.contains('Dumby')) return
@@ -534,7 +537,7 @@ export const generateMaps = (container, {
     if (!block && !map && !linkWithLine) return
     e.preventDefault()
 
-    // Add menu element
+    /** Add HTMLElement for menu */
     const menu = document.createElement('div')
     menu.classList.add('menu', 'dumby-menu')
     menu.onclick = (e) => {
@@ -584,7 +587,7 @@ export const generateMaps = (container, {
       return
     }
 
-    // Menu Items for map
+    /** Menu Items for map */
     if (map) {
       const rect = map.getBoundingClientRect()
       const [x, y] = [e.x - rect.left, e.y - rect.top]
@@ -612,13 +615,13 @@ export const generateMaps = (container, {
         }))
       }
     } else {
-      // Toggle block focus
+      /** Toggle block focus */
       if (block) {
         menu.appendChild(menuItem.toggleBlockFocus(block))
       }
     }
 
-    // Menu Items for map/block/layout
+    /** Menu Items for picking map/block/layout */
     if (!map || map.closest('.Showcase')) {
       if (dumbymap.utils.renderedMaps().length > 0) {
         menu.appendChild(menuItem.pickMapItem(dumbymap))
-- 
cgit v1.2.3-70-g09d2