Add JSDoc documentation and file headers to all source files

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

src/components/Discover/Conformance/ConformanceSidebar/ActList.vue

@@ -10,6 +10,16 @@
   </div>
 </template>
 <script setup>
+// The Lucia project.
+// Copyright 2023-2026 DSP, inc.  All rights reserved.
+// Authors:
+//   chiayin.kuo@dsp.im (chiayin), 2023/1/31
+//   imacat.yang@dsp.im (imacat), 2023/9/23
+/**
+ * @module components/Discover/Conformance/ConformanceSidebar/ActList
+ *   Checkbox-based activity list for conformance checking input.
+ */
+
 import { ref, watch } from 'vue';
 import { sortNumEngZhtw } from '@/module/sortNumEngZhtw.js';
 import emitter from '@/utils/emitter';
@@ -27,9 +37,7 @@ watch(() => props.select, (newValue) => {
   actList.value = newValue;
 });
 
-/**
- * 將選取的 Activities 傳出去
- */
+/** Emits the selected activities list via the event bus. */
 function actListData() {
   emitter.emit('actListData', actList.value);
 }

src/components/Discover/Conformance/ConformanceSidebar/ActRadio.vue

@@ -10,6 +10,18 @@
   </div>
 </template>
 <script setup>
+// The Lucia project.
+// Copyright 2023-2026 DSP, inc.  All rights reserved.
+// Authors:
+//   chiayin.kuo@dsp.im (chiayin), 2023/1/31
+//   cindy.chang@dsp.im (Cindy Chang), 2024/5/30
+//   imacat.yang@dsp.im (imacat), 2023/9/23
+/**
+ * @module components/Discover/Conformance/ConformanceSidebar/ActRadio
+ *   Radio-button activity selector for conformance checking
+ *   start/end activity input.
+ */
+
 import { ref, computed, watch } from 'vue';
 import { useConformanceInputStore } from "@/stores/conformanceInput";
 import { sortNumEngZhtw } from '@/module/sortNumEngZhtw.js';
@@ -37,9 +49,7 @@ const inputActivityRadioData = computed(() => ({
   task: selectedRadio.value,
 }));
 
-/**
- * 將選取的 Activity 傳出去
- */
+/** Emits the selected activity via event bus and updates the store. */
 function actRadioData() {
   localSelect.value = null;
   emitter.emit('actRadioData', inputActivityRadioData.value);
@@ -47,6 +57,7 @@ function actRadioData() {
   conformanceInputStore.setActivityRadioStartEndData(inputActivityRadioData.value.task);
 }
 
+/** Sets the global activity radio data state in the conformance input store. */
 function setGlobalActivityRadioDataState() {
   //this.title: value might be "From" or "To"
   conformanceInputStore.setActivityRadioStartEndData(inputActivityRadioData.value.task, props.title);

src/components/Discover/Conformance/ConformanceSidebar/ActSeqDrag.vue

@@ -42,6 +42,18 @@
   </div>
 </template>
 <script setup>
+// The Lucia project.
+// Copyright 2023-2026 DSP, inc.  All rights reserved.
+// Authors:
+//   chiayin.kuo@dsp.im (chiayin), 2023/1/31
+//   cindy.chang@dsp.im (Cindy Chang), 2024/5/30
+//   imacat.yang@dsp.im (imacat), 2023/9/23
+/**
+ * @module components/Discover/Conformance/ConformanceSidebar/ActSeqDrag
+ *   Drag-and-drop activity sequence builder for
+ *   conformance rule configuration.
+ */
+
 import { ref, computed } from 'vue';
 import { sortNumEngZhtw } from '@/module/sortNumEngZhtw.js';
 import emitter from '@/utils/emitter';

src/components/Discover/Conformance/ConformanceSidebar/ConformanceRadioGroup.vue

@@ -51,6 +51,17 @@
   </section>
 </template>
 <script setup>
+// The Lucia project.
+// Copyright 2023-2026 DSP, inc.  All rights reserved.
+// Authors:
+//   chiayin.kuo@dsp.im (chiayin), 2023/1/31
+//   imacat.yang@dsp.im (imacat), 2023/9/23
+/**
+ * @module components/Discover/Conformance/ConformanceSidebar/ConformanceRadioGroup
+ *   Radio button groups for conformance rule type, activity
+ *   sequence, mode, and process scope selection.
+ */
+
 import { storeToRefs } from 'pinia';
 import { useConformanceStore } from '@/stores/conformance';
 import emitter from '@/utils/emitter';
@@ -92,9 +103,7 @@ const actSeqFromTo = [
   {id: 3, name: 'From & To'},
 ];
 
-/**
- * 切換 Rule Type 的選項時的行為
- */
+/** Resets dependent selections when the rule type radio changes. */
 function changeRadio() {
   selectedActivitySequence.value = 'Start & End';
   selectedMode.value = 'Directly follows';
@@ -103,27 +112,19 @@ function changeRadio() {
   selectedActSeqFromTo.value = 'From';
   emitter.emit('isRadioChange', true); // Radio 切換時，資料要清空
 }
-/**
- * 切換 Activity sequence 的選項時的行為
- */
+/** Emits event when the activity sequence radio changes. */
 function changeRadioSeq() {
   emitter.emit('isRadioSeqChange',true);
 }
-/**
- * 切換 Processing time 的選項時的行為
- */
+/** Emits event when the process scope radio changes. */
 function changeRadioProcessScope() {
   emitter.emit('isRadioProcessScopeChange', true);
 }
-/**
- * 切換 Process Scope 的選項時的行為
- */
+/** Emits event when the extended activity sequence radio changes. */
 function changeRadioActSeqMore() {
   emitter.emit('isRadioActSeqMoreChange', true);
 }
-/**
- * 切換 Activity Sequence 的選項時的行為
- */
+/** Emits event when the from/to activity sequence radio changes. */
 function changeRadioActSeqFromTo() {
   emitter.emit('isRadioActSeqFromToChange', true);
 }

src/components/Discover/Conformance/ConformanceSidebar/ConformanceSelectResult.vue

@@ -29,6 +29,18 @@
   </div>
 </template>
 <script setup>
+// The Lucia project.
+// Copyright 2023-2026 DSP, inc.  All rights reserved.
+// Authors:
+//   chiayin.kuo@dsp.im (chiayin), 2023/1/31
+//   cindy.chang@dsp.im (Cindy Chang), 2024/5/30
+//   imacat.yang@dsp.im (imacat), 2023/9/23
+/**
+ * @module components/Discover/Conformance/ConformanceSidebar/ConformanceSelectResult
+ *   Conformance result list with selectable items and
+ *   scrollable display of check results.
+ */
+
 import { reactive, computed } from 'vue';
 import { storeToRefs } from 'pinia';
 import { useConformanceStore } from '@/stores/conformance';

src/components/Discover/Conformance/ConformanceSidebar/ConformanceShowBar.vue

@@ -98,6 +98,18 @@
   </section>
 </template>
 <script setup>
+// The Lucia project.
+// Copyright 2023-2026 DSP, inc.  All rights reserved.
+// Authors:
+//   chiayin.kuo@dsp.im (chiayin), 2023/1/31
+//   cindy.chang@dsp.im (Cindy Chang), 2024/5/30
+//   imacat.yang@dsp.im (imacat), 2023/9/23
+/**
+ * @module components/Discover/Conformance/ConformanceSidebar/ConformanceShowBar
+ *   Horizontal bar chart component displaying conformance
+ *   check result statistics.
+ */
+
 import { ref, computed, watch } from 'vue';
 import { storeToRefs } from 'pinia';
 import { useLoadingStore } from '@/stores/loading';
@@ -239,10 +251,9 @@ watch(() => props.isSubmitShowDataCt, (newValue) => {
 });
 
 /**
- * 設定 start and end 的 Radio Data
- * @param {object} data cfmSeqStart | cfmSeqEnd | cfmPtEteSE | cfmPtPSE | cfmWtEteSE | cfmWtPSE | cfmCtEteSE，
- * 傳入以上任一後端接到的 Activities 列表 Data。
- * @param {string} category 'start' | 'end'，傳入 'start' 或 'end'。
+ * Sets the start and end radio data.
+ * @param {object} data - Activities list data from the backend (cfmSeqStart, cfmSeqEnd, cfmPtEteSE, etc.).
+ * @param {string} category - 'start' or 'end'.
  * @returns {array}
  */
 function setTaskData(data, category) {
@@ -251,11 +262,10 @@ function setTaskData(data, category) {
   return newData;
 }
 /**
- * 重新設定連動的 start and end 的 Radio Data
- * @param {object} data cfmPtEteSE | cfmPtPSE | cfmWtEteSE | cfmWtPSE | cfmCtEteSE，
- * 傳入以上任一後端接到的 Activities 列表 Data。
- * @param {string} category 'start' | 'end'，傳入 'start' 或 'end'。
- * @param {string} task 已選擇的 Activity task
+ * Resets the linked start and end radio data.
+ * @param {object} data - Activities list data from the backend (cfmPtEteSE, cfmPtPSE, etc.).
+ * @param {string} category - 'start' or 'end'.
+ * @param {string} task - The selected activity task.
  * @returns {array}
  */
 function setStartAndEndData(data, category, taskVal) {
@@ -270,10 +280,10 @@ function setStartAndEndData(data, category, taskVal) {
   return newData;
 }
 /**
- * 重新設定 Activity sequence 連動的 start and end 的 Radio Data
- * @param {object} data cfmSeqStart | cfmSeqEnd，傳入以上任一後端接到的 Activities 列表 Data。
- * @param {string} category 'sources' | 'sinks'，傳入 'sources' 或 'sinks'。
- * @param {string} task 已選擇的 Activity task
+ * Resets the activity sequence linked start and end radio data.
+ * @param {object} data - Activities list data from the backend (cfmSeqStart or cfmSeqEnd).
+ * @param {string} category - 'sources' or 'sinks'.
+ * @param {string} task - The selected activity task.
  * @returns {array}
  */
 function setSeqStartAndEndData(data, category, taskVal) {
@@ -283,7 +293,7 @@ function setSeqStartAndEndData(data, category, taskVal) {
 }
 /**
  * select start list's task
- * @param {event} e 觸發 input 的詳細事件
+ * @param {Event} e - The input event.
  */
 function selectStart(e) {
   taskStart.value = e;
@@ -300,7 +310,7 @@ function selectStart(e) {
 }
 /**
  * select End list's task
- * @param {event} e 觸發 input 的詳細事件
+ * @param {Event} e - The input event.
  */
 function selectEnd(e) {
   taskEnd.value = e;
@@ -326,8 +336,8 @@ function reset() {
   taskEnd.value = null;
 }
 /**
- * Radio 切換時，Start & End Data 連動改變
- * @param {boolean} data true | false，傳入 true 或 false
+ * Updates linked Start & End data when radio selection changes.
+ * @param {boolean} data - Whether data should be restored from submission state.
  */
 function setResetData(data) {
   if(data) {

src/components/Discover/Conformance/ConformanceSidebar/ConformanceTimeRange.vue

@@ -68,6 +68,18 @@
 </div>
 </template>
 <script setup>
+// The Lucia project.
+// Copyright 2023-2026 DSP, inc.  All rights reserved.
+// Authors:
+//   chiayin.kuo@dsp.im (chiayin), 2023/1/31
+//   cindy.chang@dsp.im (Cindy Chang), 2024/5/30
+//   imacat.yang@dsp.im (imacat), 2023/9/23
+/**
+ * @module components/Discover/Conformance/ConformanceSidebar/ConformanceTimeRange
+ *   Time range picker for conformance time-based rule
+ *   configuration with calendar inputs.
+ */
+
 import { reactive } from 'vue';
 import { storeToRefs } from 'pinia';
 import { useConformanceStore } from '@/stores/conformance';
@@ -149,22 +161,22 @@ const storeRefs = {
 
 /**
  * get min total seconds
- * @param {Number} e 最小值總秒數
+ * @param {number} e - The minimum total seconds.
  */
 function minTotalSeconds(e) {
   emit('min-total-seconds', e);
 }
 /**
  * get min total seconds
- * @param {Number} e 最大值總秒數
+ * @param {number} e - The maximum total seconds.
  */
 function maxTotalSeconds(e) {
   emit('max-total-seconds', e);
 }
 /**
  * get Time Range(duration)
- * @param {array} data API data，Activity 列表
- * @param {string} category 'act' | 'single' | 'double'，傳入以上任一值。
+ * @param {Array} data - Activity list data from the API.
+ * @param {string} category - 'act', 'single', or 'double'.
  * @param {string} task select Radio task or start
  * @param {string} taskTwo end
  * @returns {object} {min:12, max:345}

src/components/Discover/Conformance/ConformanceSidebar/ResultArrow.vue

@@ -9,5 +9,16 @@
   </ul>
 </template>
 <script setup>
+// The Lucia project.
+// Copyright 2023-2026 DSP, inc.  All rights reserved.
+// Authors:
+//   chiayin.kuo@dsp.im (chiayin), 2023/1/31
+//   imacat.yang@dsp.im (imacat), 2023/9/23
+/**
+ * @module components/Discover/Conformance/ConformanceSidebar/ResultArrow
+ *   Conformance result display with arrow icons showing activity
+ *   sequences.
+ */
+
 defineProps(['data', 'select']);
 </script>

src/components/Discover/Conformance/ConformanceSidebar/ResultCheck.vue

@@ -9,6 +9,17 @@
   </ul>
 </template>
 <script setup>
+// The Lucia project.
+// Copyright 2023-2026 DSP, inc.  All rights reserved.
+// Authors:
+//   chiayin.kuo@dsp.im (chiayin), 2023/1/31
+//   imacat.yang@dsp.im (imacat), 2023/9/23
+/**
+ * @module components/Discover/Conformance/ConformanceSidebar/ResultCheck
+ *   Conformance result display with check-circle icons showing
+ *   matched activities.
+ */
+
 import { ref, watch } from 'vue';
 import emitter from '@/utils/emitter';
 

src/components/Discover/Conformance/ConformanceSidebar/ResultDot.vue

@@ -8,6 +8,17 @@
   </ul>
 </template>
 <script setup>
+// The Lucia project.
+// Copyright 2023-2026 DSP, inc.  All rights reserved.
+// Authors:
+//   chiayin.kuo@dsp.im (chiayin), 2023/1/31
+//   imacat.yang@dsp.im (imacat), 2023/9/23
+/**
+ * @module components/Discover/Conformance/ConformanceSidebar/ResultDot
+ *   Conformance result display with dot icons showing category
+ *   and task pairs.
+ */
+
 import { ref, watch } from 'vue';
 import emitter from '@/utils/emitter';
 

src/components/Discover/Conformance/ConformanceSidebar/TimeRangeDuration.vue

@@ -10,6 +10,18 @@
   </div>
 </template>
 <script setup>
+// The Lucia project.
+// Copyright 2023-2026 DSP, inc.  All rights reserved.
+// Authors:
+//   chiayin.kuo@dsp.im (chiayin), 2023/1/31
+//   cindy.chang@dsp.im (Cindy Chang), 2024/5/30
+//   imacat.yang@dsp.im (imacat), 2023/9/23
+/**
+ * @module components/Discover/Conformance/ConformanceSidebar/TimeRangeDuration
+ *   Time range duration picker with min/max duration inputs
+ *   for conformance time-based rules.
+ */
+
 import { ref, watch } from 'vue';
 import Durationjs from '@/components/durationjs.vue';
 
@@ -28,9 +40,7 @@ const updateMin = ref(null);
 const durationMin = ref(null);
 const durationMax = ref(null);
 
-/**
- * set props values
- */
+/** Deep-copies timeData min/max values to the Vue component boundaries. */
 function setTimeValue() {
   // 深拷貝原始 timeData 的內容
   minVuemin.value = JSON.parse(JSON.stringify(timeData.value.min));
@@ -40,8 +50,8 @@ function setTimeValue() {
 }
 
 /**
- * get min total seconds
- * @param {Number} e 元件傳來的最小值總秒數
+ * Handles the minimum duration total seconds update.
+ * @param {number} e - The total seconds from the min duration component.
  */
 function minTotalSeconds(e) {
   timeRangeMin.value = e;
@@ -50,8 +60,8 @@ function minTotalSeconds(e) {
 }
 
 /**
- * get min total seconds
- * @param {Number} e 元件傳來的最大值總秒數
+ * Handles the maximum duration total seconds update.
+ * @param {number} e - The total seconds from the max duration component.
  */
 function maxTotalSeconds(e) {
   timeRangeMax.value = e;