chore(eslint): jsdoc rules

- jsdoc/tag-lines

Signed-off-by: Maksim Sukharev <[email protected]>

Author: Antreesy

eslint.config.mjs

@@ -24,7 +24,6 @@ export default [
 			'@typescript-eslint/no-unused-vars': 'off',
 			'@typescript-eslint/no-use-before-define': 'off',
 			'curly': 'off',
-			'jsdoc/tag-lines': 'off',
 			'import-extensions/extensions': 'off',
 			'vue/first-attribute-linebreak': 'off',
 			'vue/no-boolean-default': 'off',

src/App.vue

@@ -86,6 +86,7 @@ function onShowServerLog() {
 
 /**
  * Handle paste events with log entries
+ *
  * @param event The keyboard event
  */
 function onHandlePaste(event: ClipboardEvent) {

src/components/settings/SettingsDatetimeFormat.vue

@@ -76,7 +76,7 @@ const dateTimeFormat = computed(() => settingsStore.dateTimeFormat)
 
 /**
  *
- * @param v
+ * @param v - How the log time should be displayed ('local' | 'raw' | 'utc' | 'relative')
  */
 function setDateTimeFormat(v: IAppSettings['dateTimeFormat']) {
   return settingsStore

src/components/settings/SettingsSetLogLevel.vue

@@ -38,7 +38,7 @@ const logLevel = computed(() => `${settingsStore.logLevel}`)
 
 /**
  *
- * @param level
+ * @param level - The loglevel which is currently set on the server (0 | 1 | 2 | 3 | 4)
  */
 function setLogLevel(level: string) {
 	const numericLevel = parseInt(level) as IAppSettings['logLevel']

src/components/table/LogTableHeader.vue

@@ -38,11 +38,13 @@ import IconSortDescending from 'vue-material-design-icons/SortDescending.vue'
 interface Props {
 	/**
 	 * Whether the column is sortable
+	 *
 	 * @default true
 	 */
 	sortable?: boolean
 	/**
 	 * Current sorting
+	 *
 	 * @default ''
 	 */
 	sorted?: ISortingOptions

src/store/logging.ts

@@ -103,6 +103,7 @@ export const useLogStore = defineStore('logreader-logs', () => {
 
 	/**
 	 * Load entries from string
+	 *
 	 * @param text clipboard text content
 	 */
 	async function loadText(text: string) {

src/utils/format.ts

@@ -12,7 +12,7 @@ import { useSettingsStore } from '../store/settings'
 
 /**
  *
- * @param pinia
+ * @param pinia Pinia instance
  */
 export function useLogFormatting(pinia?: Pinia) {
 	const settingsStore = useSettingsStore(pinia)

src/utils/logfile.ts

@@ -40,6 +40,7 @@ export async function parseLogString(raw: string): Promise<ILogEntry[]> {
 
 /**
  * Parse a raw (unknown type of) log entry into a modern log entry
+ *
  * @param entry The raw log entry
  */
 export function parseRawLogEntry(entry: IRawLogEntry): ILogEntry {