Fix JSDoc errors: remove unsupported @constant tags and correct @param names

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-03-10 10:20:05 +08:00
parent 093eabaea3
commit 97748bea60
5 changed files with 21 additions and 21 deletions

View File

@@ -6,34 +6,34 @@
// cindy.chang@dsp.im (Cindy Chang), 2024/5/30 // cindy.chang@dsp.im (Cindy Chang), 2024/5/30
/** @module constants Application-wide constants and chart configuration. */ /** @module constants Application-wide constants and chart configuration. */
/** @constant {number} Maximum number of ticks on PrimeVue chart axes. */ /**Maximum number of ticks on PrimeVue chart axes. */
export const PRIME_VUE_TICKS_LIMIT = 6; export const PRIME_VUE_TICKS_LIMIT = 6;
/** @constant {number} Number of data items to render per batch. */ /**Number of data items to render per batch. */
export const ONCE_RENDER_NUM_OF_DATA = 9; export const ONCE_RENDER_NUM_OF_DATA = 9;
/** @constant {number} Minimum valid password length. */ /**Minimum valid password length. */
export const PWD_VALID_LENGTH = 6; export const PWD_VALID_LENGTH = 6;
/** @constant {string} Default grid line color (Tailwind slate-500). */ /**Default grid line color (Tailwind slate-500). */
export const GRID_COLOR = "#64748b"; export const GRID_COLOR = "#64748b";
/** @constant {string} Modal type for creating a new account. */ /**Modal type for creating a new account. */
export const MODAL_CREATE_NEW = "MODAL_CREATE_NEW"; export const MODAL_CREATE_NEW = "MODAL_CREATE_NEW";
/** @constant {string} Modal type for editing an account. */ /**Modal type for editing an account. */
export const MODAL_ACCT_EDIT = "MODAL_ACCT_EDIT"; export const MODAL_ACCT_EDIT = "MODAL_ACCT_EDIT";
/** @constant {string} Modal type for viewing account info. */ /**Modal type for viewing account info. */
export const MODAL_ACCT_INFO = "MODAL_ACCT_INFO"; export const MODAL_ACCT_INFO = "MODAL_ACCT_INFO";
/** @constant {string} Modal type for deleting an account. */ /**Modal type for deleting an account. */
export const MODAL_DELETE = "MODAL_DELETE"; export const MODAL_DELETE = "MODAL_DELETE";
/** @constant {string} LocalStorage key for saved Cytoscape node positions. */ /**LocalStorage key for saved Cytoscape node positions. */
export const SAVE_KEY_NAME = "CYTOSCAPE_NODE_POSITION"; export const SAVE_KEY_NAME = "CYTOSCAPE_NODE_POSITION";
/** @constant {number} Duration (minutes) to highlight newly created accounts. */ /**Duration (minutes) to highlight newly created accounts. */
export const JUST_CREATE_ACCOUNT_HOT_DURATION_MINS = 2; export const JUST_CREATE_ACCOUNT_HOT_DURATION_MINS = 2;
/** /**
* @constant {Array<[string, string]>} Field keys and display labels for * Field keys and display labels for process insights
* process insights (self-loops, short-loops, traces). * (self-loops, short-loops, traces).
*/ */
export const INSIGHTS_FIELDS_AND_LABELS = [ export const INSIGHTS_FIELDS_AND_LABELS = [
["self_loops", "Self-Loop"], ["self_loops", "Self-Loop"],
@@ -43,7 +43,7 @@ export const INSIGHTS_FIELDS_AND_LABELS = [
["most_freq_traces", "Most Frequent Trace"], ["most_freq_traces", "Most Frequent Trace"],
]; ];
/** @constant {Object} Default Chart.js layout padding options. */ /**Default Chart.js layout padding options. */
export const knownLayoutChartOption = { export const knownLayoutChartOption = {
padding: { padding: {
top: 16, top: 16,
@@ -52,7 +52,7 @@ export const knownLayoutChartOption = {
}, },
}; };
/** @constant {Object} Default Chart.js scale options for line charts. */ /**Default Chart.js scale options for line charts. */
export const knownScaleLineChartOptions = { export const knownScaleLineChartOptions = {
x: { x: {
type: "time", type: "time",
@@ -108,7 +108,7 @@ export const knownScaleLineChartOptions = {
}, },
}, },
}; };
/** @constant {Object} Default Chart.js scale options for horizontal charts. */ /**Default Chart.js scale options for horizontal charts. */
export const knownScaleHorizontalChartOptions = { export const knownScaleHorizontalChartOptions = {
x: { x: {
title: { title: {
@@ -156,7 +156,7 @@ export const knownScaleHorizontalChartOptions = {
}, },
}, },
}; };
/** @constant {Object} Default Chart.js scale options for bar charts. */ /**Default Chart.js scale options for bar charts. */
export const knownScaleBarChartOptions = { export const knownScaleBarChartOptions = {
x: { x: {
title: { title: {

View File

@@ -309,8 +309,8 @@ export const useAcctMgmtStore = defineStore('acctMgmtStore', {
}, },
/** /**
* According to mouseover or mouseleave status, change the bool value. * According to mouseover or mouseleave status, change the bool value.
* @param {string} username * @param {string} username
* @param {boolean} isEditHovered * @param {boolean} isDetailHovered
*/ */
changeIsDetailHoveredByUser(username: string, isDetailHovered: boolean) { changeIsDetailHoveredByUser(username: string, isDetailHovered: boolean) {
const userToChange = this.allUserAccountList.find(user => user.username === username); const userToChange = this.allUserAccountList.find(user => user.username === username);

View File

@@ -40,7 +40,7 @@ export const useCytoscapeStore = defineStore('cytoscapeStore', {
actions: { actions: {
/** /**
* Saves or updates the position of a single node. * Saves or updates the position of a single node.
* @param {string} id - The node ID. * @param {string} nodeId - The node ID.
* @param {{x: number, y: number}} position - The node position. * @param {{x: number, y: number}} position - The node position.
* @param {string} direction - Layout direction ('TB' or 'LR'). * @param {string} direction - Layout direction ('TB' or 'LR').
*/ */

View File

@@ -231,7 +231,7 @@ export const useFilesStore = defineStore("filesStore", {
* Rename a Log * Rename a Log
* @param {string} type - The file type ('log', 'filter', 'log-check', or 'filter-check'). * @param {string} type - The file type ('log', 'filter', 'log-check', or 'filter-check').
* @param {number} id - The file ID. * @param {number} id - The file ID.
* @param {string} name - The file name. * @param {string} fileName - The file name.
*/ */
async rename(type, id, fileName) { async rename(type, id, fileName) {
// If uploadLogId exists, set id and type accordingly; then check the file type. // If uploadLogId exists, set id and type accordingly; then check the file type.

View File

@@ -101,7 +101,7 @@ export const usePageAdminStore = defineStore("pageAdminStore", {
* Also, start pending state. * Also, start pending state.
* Often, user triggers the modal and the pending state starts. * Often, user triggers the modal and the pending state starts.
* Note: String conversion is needed. For Example, CheckMap is converted into MAP * Note: String conversion is needed. For Example, CheckMap is converted into MAP
* @param {string} pendingActivePage * @param {string} argPendingActivePage
*/ */
setPendingActivePage(argPendingActivePage) { setPendingActivePage(argPendingActivePage) {
printPageAdminLog && printPageAdminLog &&