Add JSDoc documentation and file headers to all source files

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-03-06 18:55:36 +08:00
parent 3b7b6ae859
commit 7fec6cb63f
199 changed files with 2764 additions and 503 deletions

View File

@@ -1,4 +1,15 @@
// The Lucia project.
// Copyright 2024-2026 DSP, inc. All rights reserved.
// Authors:
// cindy.chang@dsp.im (Cindy Chang), 2024/7/9
/**
* @module types/apiError.d
* Type declaration for the apiError module.
*/
/** Type declaration for the apiError module. */
declare module '@/module/apiError' {
/** The API error handler. */
const apiError: any;
export default apiError;
}

18
src/types/env.d.ts vendored
View File

@@ -1,9 +1,23 @@
// The Lucia project.
// Copyright 2024-2026 DSP, inc. All rights reserved.
// Authors:
// cindy.chang@dsp.im (Cindy Chang), 2024/7/9
/**
* @module types/env.d
* Type declarations for Vite environment variables.
*/
/** Vite environment variable types. */
interface ImportMetaEnv {
/** The application title. */
readonly VITE_APP_TITLE: string;
/** The base URL for the application. */
readonly BASE_URL: string;
// 更多環境變量...
// Add more environment variables as needed.
}
/** Augments ImportMeta with typed env. */
interface ImportMeta {
/** The typed environment variables. */
readonly env: ImportMetaEnv;
}

View File

@@ -1,6 +1,18 @@
// src/types/shims-vue.d.ts
// The Lucia project.
// Copyright 2024-2026 DSP, inc. All rights reserved.
// Authors:
// cindy.chang@dsp.im (Cindy Chang), 2024/7/9
// imacat.yang@dsp.im (imacat), 2026/3/6
/**
* @module types/shims-vue.d
* Vue single-file component type shim for
* TypeScript module resolution.
*/
/** Declares *.vue files as Vue components for TypeScript. */
declare module '*.vue' {
import { DefineComponent } from 'vue';
/** The default-exported Vue component. */
const component: DefineComponent<{}, {}, any>;
export default component;
}

13
src/types/store.d.ts vendored
View File

@@ -1,8 +1,21 @@
// The Lucia project.
// Copyright 2024-2026 DSP, inc. All rights reserved.
// Authors:
// cindy.chang@dsp.im (Cindy Chang), 2024/7/9
// imacat.yang@dsp.im (imacat), 2026/3/6
/**
* @module types/store.d
* Pinia custom properties type augmentation
* for router access in stores.
*/
import 'pinia';
import { Router } from 'vue-router';
declare module 'pinia' {
/** Extends Pinia stores with router access. */
export interface PiniaCustomProperties {
/** The Vue Router instance. */
$router: Router;
}
}

View File

@@ -1 +1,11 @@
// The Lucia project.
// Copyright 2024-2026 DSP, inc. All rights reserved.
// Authors:
// cindy.chang@dsp.im (Cindy Chang), 2024/7/9
// imacat.yang@dsp.im (imacat), 2026/3/6
/**
* @module types/vue-axios.d
* Former vue-axios type declarations (removed).
*/
// vue-axios type declarations removed — API client is used directly

View File

@@ -1,8 +1,22 @@
// The Lucia project.
// Copyright 2024-2026 DSP, inc. All rights reserved.
// Authors:
// cindy.chang@dsp.im (Cindy Chang), 2024/7/9
/**
* @module types/vue-router.d
* Vue Router type augmentation for the Vue
* instance $router and $route properties.
*/
import { Router, RouteLocationNormalized } from 'vue-router';
/** Augments the Vue instance with router properties. */
declare module 'vue/types/vue' {
/** Vue instance augmentation. */
interface Vue {
/** The Vue Router instance. */
$router: Router;
/** The current normalized route location. */
$route: RouteLocationNormalized;
}
}

10
src/types/vue.d.ts vendored
View File

@@ -1 +1,11 @@
// The Lucia project.
// Copyright 2024-2026 DSP, inc. All rights reserved.
// Authors:
// cindy.chang@dsp.im (Cindy Chang), 2024/7/9
// imacat.yang@dsp.im (imacat), 2026/3/6
/**
* @module types/vue.d
* Vue App type import (placeholder).
*/
import { App } from 'vue';