fix: update ignore comments for various facade interfaces

dream-num · Jan 23, 2025 · 6893a9e · 6893a9e
1 parent d9bf795
commit 6893a9e
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 7 deletions.
diff --git a/packages/sheets-filter/src/facade/f-worksheet.ts b/packages/sheets-filter/src/facade/f-worksheet.ts
@@ -20,7 +20,9 @@ import { SheetsFilterService } from '@univerjs/sheets-filter';
 import { FWorksheet } from '@univerjs/sheets/facade';
 import { FFilter } from './f-filter';
 
-/** @ignore */
+/**
+ * @ignore
+ */
 export interface IFWorksheetFilter {
     /**
      * Get the filter for the current worksheet.

diff --git a/packages/sheets-sort/src/facade/f-worksheet.ts b/packages/sheets-sort/src/facade/f-worksheet.ts
@@ -20,7 +20,9 @@ import { type IRange, RANGE_TYPE } from '@univerjs/core';
 import { SortRangeCommand, SortType } from '@univerjs/sheets-sort';
 import { FWorksheet } from '@univerjs/sheets/facade';
 
-/** @ignore */
+/**
+ * @ignore
+ */
 export interface IFWorksheetSort {
     /**
      * Sort the worksheet by the specified column.

diff --git a/packages/sheets-ui/src/facade/f-univer.ts b/packages/sheets-ui/src/facade/f-univer.ts
@@ -248,6 +248,9 @@ export class FUniverSheetsUIMixin extends FUniver implements IFUniverSheetsUIMix
         this._initObserverListener(injector);
     }
 
+    /**
+     * @ignore
+     */
     // eslint-disable-next-line max-lines-per-function
     _initObserverListener(injector: Injector): void {
         const univerInstanceService = injector.get(IUniverInstanceService);

diff --git a/packages/sheets-ui/src/facade/f-workbook.ts b/packages/sheets-ui/src/facade/f-workbook.ts
@@ -26,7 +26,9 @@ import { FWorkbook } from '@univerjs/sheets/facade';
 import { type IDialogPartMethodOptions, IDialogService, type ISidebarMethodOptions, ISidebarService, KeyCode } from '@univerjs/ui';
 import { filter } from 'rxjs';
 
-/** @ignore */
+/**
+ * @ignore
+ */
 export interface IFWorkbookSheetsUIMixin {
     /**
      * Open a sidebar.

diff --git a/packages/sheets-ui/src/facade/f-worksheet.ts b/packages/sheets-ui/src/facade/f-worksheet.ts
@@ -23,7 +23,9 @@ import { IRenderManagerService, SHEET_VIEWPORT_KEY, sheetContentViewportKeys } f
 import { ChangeZoomRatioCommand, SetWorksheetColAutoWidthCommand, SheetScrollManagerService, SheetSkeletonManagerService, SheetsScrollRenderController } from '@univerjs/sheets-ui';
 import { FWorksheet } from '@univerjs/sheets/facade';
 
-/** @ignore */
+/**
+ * @ignore
+ */
 export interface IFWorksheetSkeletonMixin {
     /**
      * Refresh the canvas.

diff --git a/packages/ui/src/facade/f-menu-builder.ts b/packages/ui/src/facade/f-menu-builder.ts
@@ -76,7 +76,9 @@ export interface IFacadeSubmenuItem {
     order?: number;
 }
 
-/** @ignore */
+/**
+ * @ignore
+ */
 type FAllMenu = FMenu | FSubmenu;
 
 /**
@@ -183,7 +185,9 @@ export class FMenu extends FMenuBase {
         }
     }
 
-    /** @ignore */
+    /**
+     * @ignore
+     */
     __getSchema(): { [key: string]: MenuSchemaType } {
         this._commandToRegister.forEach((command, id) => {
             if (!this._commandService.hasCommand(id)) {
@@ -260,7 +264,9 @@ export class FSubmenu extends FMenuBase {
         return this;
     }
 
-    /** @ignore */
+    /**
+     * @ignore
+     */
     __getSchema(): { [key: string]: MenuSchemaType } {
         const schema: { [key: string]: MenuSchemaType } = {};
         this.addSeparator();