From e391c9a2376774c2be26cec9bf19745511299de2 Mon Sep 17 00:00:00 2001 From: chiayin Date: Fri, 29 Mar 2024 15:49:05 +0800 Subject: [PATCH] docs: Update all files JSDoc. --- src/assets/tailwind.css | 1 - src/assets/vendors.css | 6 --- src/components/Compare/SidebarStates.vue | 8 +--- .../Conformance/ConformanceResults.vue | 12 ++--- .../Conformance/ConformanceSidebar.vue | 7 ++- .../ConformanceSidebar/ActList.vue | 3 ++ .../ConformanceSidebar/ActRadio.vue | 3 ++ .../ConformanceSidebar/ActSeqDrag.vue | 1 - .../ConformanceRadioGroup.vue | 15 +++++++ .../ConformanceSelectResult.vue | 22 ---------- .../ConformanceSidebar/ConformanceShowBar.vue | 22 +++++----- .../ConformanceTimeRange.vue | 8 ++-- .../ConformanceSidebar/ResultArrow.vue | 13 ------ .../ConformanceSidebar/TimeRangeDuration.vue | 6 +-- .../Discover/Conformance/MoreModal.vue | 8 ++-- .../Discover/Map/Filter/ActAndSeq.vue | 2 + src/components/Discover/Map/Filter/ActOcc.vue | 5 ++- .../Discover/Map/Filter/ActOccCase.vue | 14 ++++++ .../Discover/Map/Filter/Attributes.vue | 12 +++-- src/components/Discover/Map/Filter/Funnel.vue | 3 +- .../Discover/Map/Filter/Timeframes.vue | 15 +++++++ src/components/Discover/Map/Filter/Trace.vue | 9 ++-- src/components/Discover/Map/SidebarFilter.vue | 17 ++++--- src/components/Discover/Map/SidebarState.vue | 2 +- src/components/Discover/Map/SidebarTraces.vue | 9 ++-- src/components/Discover/Map/SidebarView.vue | 10 ++--- src/components/Discover/StatusBar.vue | 2 +- src/components/File/UploadModal.vue | 4 ++ src/components/Header.vue | 3 ++ src/components/Navbar.vue | 7 +-- src/components/durationjs.vue | 19 ++++---- src/module/abbreviateNumber.js | 2 +- src/module/alertModal.js | 44 +++++++++---------- src/module/apiError.js | 4 +- src/module/cytoscapeMap.js | 2 +- src/module/cytoscapeMapTrace.js | 2 +- src/module/numberLabel.js | 2 +- src/module/setChartData.js | 8 ++-- src/module/shortScaleNumber.js | 2 +- src/module/sortNumEngZhtw.js | 2 +- src/module/timeLabel.js | 4 +- src/router/index.js | 18 ++++---- src/stores/allMapData.js | 2 + src/stores/compare.js | 3 ++ src/stores/conformance.js | 10 +++++ src/stores/files.js | 19 ++++---- src/stores/login.js | 2 +- src/stores/performance.js | 2 + src/views/Compare/Dashboard/index.vue | 10 ++--- src/views/Discover/Map/index.vue | 16 +++---- src/views/Discover/Performance/index.vue | 10 ++--- src/views/Files/index.vue | 34 +++++++------- src/views/Login/index.vue | 1 + src/views/MemberArea/index.vue | 2 - src/views/Upload/index.vue | 10 ++--- 55 files changed, 260 insertions(+), 219 deletions(-) diff --git a/src/assets/tailwind.css b/src/assets/tailwind.css index 85ab496..3bc5e88 100644 --- a/src/assets/tailwind.css +++ b/src/assets/tailwind.css @@ -6,7 +6,6 @@ @tailwind utilities; @layer tailwind-base, primevue; -/* @layer tailwind-base, primevue, tailwind-utilities; */ @layer tailwind-base { @tailwind base; diff --git a/src/assets/vendors.css b/src/assets/vendors.css index 5851a61..fd323fe 100644 --- a/src/assets/vendors.css +++ b/src/assets/vendors.css @@ -71,7 +71,6 @@ @apply !h-1 } /* radio */ -/* inline-block h-4 w-4 m-2 cursor-pointer rounded-full ring-2 ring-neutral-300 shadow-sm peer-checked:ring-2 peer-checked:ring-primary peer-checked:ring-offset-2 peer-checked:bg-primary */ /* p-radiobutton p-radiobutton-box p-radiobutton-icon */ @@ -95,11 +94,6 @@ p-radiobutton-icon */ @apply !p-0 } /* DataTable */ -/* .p-datatable table { - border-collapse: collapse; - min-width: 100%; - table-layout: fixed; -} */ .p-datatable-resizable > .p-datatable-wrapper { @apply !overflow-x-visible } diff --git a/src/components/Compare/SidebarStates.vue b/src/components/Compare/SidebarStates.vue index 1a50fc7..67481ba 100644 --- a/src/components/Compare/SidebarStates.vue +++ b/src/components/Compare/SidebarStates.vue @@ -2,9 +2,6 @@
@@ -183,7 +180,7 @@ export default { methods: { /** * Number to percentage - * @param {number} val + * @param {number} val 原始數字 * @returns {string} 轉換完成的百分比字串 */ getPercentLabel(val){ @@ -194,7 +191,7 @@ export default { * setting stats data * @param { object } data fetch API stats data * @param { string } fileName file Name - * @returns { object } primaryStatData | secondaryStatData + * @returns { object } primaryStatData | secondaryStatData,回傳 primaryStatData 或 secondaryStatData */ getStatData(data, fileName) { return { @@ -269,7 +266,6 @@ export default { const secondaryFileName = await this.compareStore.getFileName(secondaryId) this.primaryStatData = await this.getStatData(primaryData, primaryFileName); this.secondaryStatData = await this.getStatData(secondaryData, secondaryFileName); - } } diff --git a/src/components/Discover/Conformance/ConformanceResults.vue b/src/components/Discover/Conformance/ConformanceResults.vue index 4d3394a..c2a4859 100644 --- a/src/components/Discover/Conformance/ConformanceResults.vue +++ b/src/components/Discover/Conformance/ConformanceResults.vue @@ -284,7 +284,7 @@ export default { methods: { /** * set progress bar width - * @param {number} value + * @param {number} value 百分比數字 * @returns {string} 樣式的寬度設定 */ progressWidth(value){ @@ -292,7 +292,7 @@ export default { }, /** * Number to percentage - * @param {number} val + * @param {number} val 原始數字 * @returns {string} 轉換完成的百分比字串 */ getPercentLabel(val){ @@ -301,7 +301,7 @@ export default { }, /** * Convert seconds to days - * @param {number} sec + * @param {number} sec 秒數 * @returns {number} day */ convertSecToDay(sec) { @@ -309,7 +309,7 @@ export default { }, /** * Open Issues Modal. - * @param {number} no trace no + * @param {number} no trace 編號 */ async openMore(no) { // async await 解決非同步資料延遲傳遞導致未讀取到而出錯的問題 @@ -321,7 +321,7 @@ export default { }, /** * Open Loop Modal. - * @param {number} no trace no + * @param {number} no trace 編號 */ async openLoopMore(no) { // async await 解決非同步資料延遲傳遞導致未讀取到而出錯的問題 @@ -333,7 +333,7 @@ export default { }, /** * set conformance report data - * @param {object} data new watch's value + * @param {object} data new watch's value 監聽到後端傳來的報告 data */ setConformanceTempReportData(data){ let total = getNumberLabel(Object.values(data.counts).reduce((acc, val) => acc + val, 0)); diff --git a/src/components/Discover/Conformance/ConformanceSidebar.vue b/src/components/Discover/Conformance/ConformanceSidebar.vue index 5c24a5b..aaa0f70 100644 --- a/src/components/Discover/Conformance/ConformanceSidebar.vue +++ b/src/components/Discover/Conformance/ConformanceSidebar.vue @@ -691,14 +691,14 @@ export default { methods: { /** * get min total seconds - * @param {Number} e + * @param {Number} e 最小值總秒數 */ minTotalSeconds(e) { this.selectTimeRangeMin = e; }, /** * get min total seconds - * @param {Number} e + * @param {Number} e 最大值總秒數 */ maxTotalSeconds(e) { this.selectTimeRangeMax = e; @@ -784,7 +784,7 @@ export default { this.isSubmitTimeCfmCtEteSE = { base: {}, rule: {}}; }, /** - * @param {boolean} massage true | false 清空選單選項, 選擇的結果 + * 清空選單的行為 */ reset() { // Results page Cover Plate(遮罩為 ture) @@ -825,7 +825,6 @@ export default { isEndSelected: true }; } - }, /** * Apply button 發送選項,取得 Check Id. diff --git a/src/components/Discover/Conformance/ConformanceSidebar/ActList.vue b/src/components/Discover/Conformance/ConformanceSidebar/ActList.vue index b1b3c50..dc54366 100644 --- a/src/components/Discover/Conformance/ConformanceSidebar/ActList.vue +++ b/src/components/Discover/Conformance/ConformanceSidebar/ActList.vue @@ -32,6 +32,9 @@ export default { } }, methods: { + /** + * 將選取的 Activities 傳出去 + */ actListData() { this.$emitter.emit('actListData', this.actList); } diff --git a/src/components/Discover/Conformance/ConformanceSidebar/ActRadio.vue b/src/components/Discover/Conformance/ConformanceSidebar/ActRadio.vue index 96617c2..6ede655 100644 --- a/src/components/Discover/Conformance/ConformanceSidebar/ActRadio.vue +++ b/src/components/Discover/Conformance/ConformanceSidebar/ActRadio.vue @@ -33,6 +33,9 @@ export default { }, }, methods: { + /** + * 將選取的 Activity 傳出去 + */ actRadioData() { this.localSelect = null; this.$emitter.emit('actRadioData', { diff --git a/src/components/Discover/Conformance/ConformanceSidebar/ActSeqDrag.vue b/src/components/Discover/Conformance/ConformanceSidebar/ActSeqDrag.vue index 5f70466..11f05dc 100644 --- a/src/components/Discover/Conformance/ConformanceSidebar/ActSeqDrag.vue +++ b/src/components/Discover/Conformance/ConformanceSidebar/ActSeqDrag.vue @@ -40,7 +40,6 @@
- diff --git a/src/components/Discover/Conformance/ConformanceSidebar/TimeRangeDuration.vue b/src/components/Discover/Conformance/ConformanceSidebar/TimeRangeDuration.vue index 27211ed..a122d39 100644 --- a/src/components/Discover/Conformance/ConformanceSidebar/TimeRangeDuration.vue +++ b/src/components/Discover/Conformance/ConformanceSidebar/TimeRangeDuration.vue @@ -68,16 +68,16 @@ export default { }, /** * get min total seconds - * @param {Number} e + * @param {Number} e 元件傳來的最小值總秒數 */ - minTotalSeconds(e) { + minTotalSeconds(e) { this.timeRangeMin = e; this.updateMin = e; this.$emit('min-total-seconds', e); }, /** * get min total seconds - * @param {Number} e + * @param {Number} e 元件傳來的最大值總秒數 */ maxTotalSeconds(e) { this.timeRangeMax = e; diff --git a/src/components/Discover/Conformance/MoreModal.vue b/src/components/Discover/Conformance/MoreModal.vue index 6d01d2e..e17546a 100644 --- a/src/components/Discover/Conformance/MoreModal.vue +++ b/src/components/Discover/Conformance/MoreModal.vue @@ -160,7 +160,7 @@ export default { methods: { /** * Number to percentage - * @param {number} val + * @param {number} val 原始數字 * @returns {string} 轉換完成的百分比字串 */ getPercentLabel(val){ @@ -169,7 +169,7 @@ export default { }, /** * set progress bar width - * @param {number} value + * @param {number} value 百分比數字 * @returns {string} 樣式的寬度設定 */ progressWidth(value){ @@ -177,7 +177,7 @@ export default { }, /** * switch case data - * @param {number} id + * @param {number} id case id */ async switchCaseData(id) { if(id == this.showTraceId) return; @@ -262,7 +262,7 @@ export default { }, /** * 無限滾動: 監聽 scroll 有沒有滾到底部 - * @param {element} event + * @param {element} event 監聽時回傳的事件 */ handleScroll(event) { if(this.maxItems || this.infiniteData.length < 20 || this.infiniteFinish === false) return; diff --git a/src/components/Discover/Map/Filter/ActAndSeq.vue b/src/components/Discover/Map/Filter/ActAndSeq.vue index 05d80b7..5093e4d 100644 --- a/src/components/Discover/Map/Filter/ActAndSeq.vue +++ b/src/components/Discover/Map/Filter/ActAndSeq.vue @@ -124,6 +124,7 @@ export default { }, /** * Element dragging started + * @param {event} evt input 傳入的事件 */ onStart(evt) { const lastChild = evt.to.lastChild.lastChild; @@ -137,6 +138,7 @@ export default { }, /** * Element dragging ended + * @param {event} evt input 傳入的事件 */ onEnd(evt) { // 顯示拖曳元素 diff --git a/src/components/Discover/Map/Filter/ActOcc.vue b/src/components/Discover/Map/Filter/ActOcc.vue index 09b7cc8..3c42af3 100644 --- a/src/components/Discover/Map/Filter/ActOcc.vue +++ b/src/components/Discover/Map/Filter/ActOcc.vue @@ -30,7 +30,6 @@ -