fix: update ignore comments for various facade interfaces

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

Hide file tree

Showing 13 changed files with 262 additions and 245 deletions.
diff --git a/packages/core/src/facade/f-event.ts b/packages/core/src/facade/f-event.ts
@@ -135,8 +135,8 @@ export class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.DocCreated, (params) => {
-     *     const { unitId, type, doc, unit } = params;
-     *     console.log('doc created', params);
+     *   const { unitId, type, doc, unit } = params;
+     *   console.log('doc created', params);
      * });
      * ```
      */
@@ -150,8 +150,8 @@ export class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.DocDisposed, (params) => {
-     *     const { unitId, unitType, snapshot } = params;
-     *     console.log('doc disposed', params);
+     *   const { unitId, unitType, snapshot } = params;
+     *   console.log('doc disposed', params);
      * });
      * ```
      */
@@ -165,8 +165,8 @@ export class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.LifeCycleChanged, (params) => {
-     *      const { stage } = params;
-     *     console.log('life cycle changed', params);
+     *   const { stage } = params;
+     *   console.log('life cycle changed', params);
      * });
      * ```
      */
@@ -180,8 +180,8 @@ export class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.Redo, (event) => {
-     *     const { params, id, type } = event;
-     *     console.log('command executed', event);
+     *   const { params, id, type } = event;
+     *   console.log('command executed', event);
      * });
      * ```
      */
@@ -195,8 +195,8 @@ export class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.Undo, (event) => {
-     *     const { params, id, type } = event;
-     *     console.log('command executed', event);
+     *   const { params, id, type } = event;
+     *   console.log('command executed', event);
      * });
      * ```
      */
@@ -210,8 +210,8 @@ export class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.BeforeRedo, (event) => {
-     *     const { params, id, type } = event;
-     *     console.log('command executed', event);
+     *   const { params, id, type } = event;
+     *   console.log('command executed', event);
      * });
      * ```
      */
@@ -225,8 +225,8 @@ export class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.BeforeUndo, (event) => {
-     *     const { params, id, type } = event;
-     *     console.log('command executed', event);
+     *   const { params, id, type } = event;
+     *   console.log('command executed', event);
      * });
      * ```
      */
@@ -240,8 +240,8 @@ export class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.CommandExecuted, (event) => {
-     *     const { params, id, type } = event;
-     *     console.log('command executed', event);
+     *   const { params, id, type } = event;
+     *   console.log('command executed', event);
      * });
      * ```
      */
@@ -255,8 +255,8 @@ export class FEventName {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.BeforeCommandExecute, (event) => {
-     *     const { params, id, type } = event;
-     *     console.log('command executed', event);
+     *   const { params, id, type } = event;
+     *   console.log('command executed', event);
      * });
      * ```
      */

diff --git a/packages/core/src/facade/f-univer.ts b/packages/core/src/facade/f-univer.ts
@@ -304,7 +304,7 @@ export class FUniver extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.addEvent(univerAPI.event.UnitCreated, (params) => {
-     *     console.log('unit created', params);
+     *   console.log('unit created', params);
      * });
      * ```
      */
@@ -350,7 +350,7 @@ export class FUniver extends FBaseInitialable {
      * @returns {FBlob} The new blob instance
      * @example
      * ```ts
-     * const blob = univerApi.newBlob();
+     * const blob = univerAPI.newBlob();
      * ```
      */
     newBlob(): FBlob {
@@ -362,7 +362,7 @@ export class FUniver extends FBaseInitialable {
      * @returns {ColorBuilder} The new color instance
      * @example
      * ```ts
-     * const color = univerApi.newColor();
+     * const color = univerAPI.newColor();
      * ```
      */
     newColor(): ColorBuilder {
@@ -375,7 +375,7 @@ export class FUniver extends FBaseInitialable {
      * @returns {RichTextBuilder} The new rich text instance
      * @example
      * ```ts
-     * const richText = univerApi.newRichText();
+     * const richText = univerAPI.newRichText();
      * ```
      */
     newRichText(data?: IDocumentData): RichTextBuilder {
@@ -388,7 +388,7 @@ export class FUniver extends FBaseInitialable {
      * @returns {RichTextValue} The new rich text value instance
      * @example
      * ```ts
-     * const richTextValue = univerApi.newRichTextValue();
+     * const richTextValue = univerAPI.newRichTextValue();
      * ```
      */
     newRichTextValue(data: IDocumentData): RichTextValue {
@@ -401,7 +401,7 @@ export class FUniver extends FBaseInitialable {
      * @returns {ParagraphStyleBuilder} The new paragraph style instance
      * @example
      * ```ts
-     * const paragraphStyle = univerApi.newParagraphStyle();
+     * const paragraphStyle = univerAPI.newParagraphStyle();
      * ```
      */
     newParagraphStyle(style?: IParagraphStyle): ParagraphStyleBuilder {
@@ -414,7 +414,7 @@ export class FUniver extends FBaseInitialable {
      * @returns {ParagraphStyleValue} The new paragraph style value instance
      * @example
      * ```ts
-     * const paragraphStyleValue = univerApi.newParagraphStyleValue();
+     * const paragraphStyleValue = univerAPI.newParagraphStyleValue();
      * ```
      */
     newParagraphStyleValue(style?: IParagraphStyle): ParagraphStyleValue {
@@ -427,7 +427,7 @@ export class FUniver extends FBaseInitialable {
      * @returns {TextStyleBuilder} The new text style instance
      * @example
      * ```ts
-     * const textStyle = univerApi.newTextStyle();
+     * const textStyle = univerAPI.newTextStyle();
      * ```
      */
     newTextStyle(style?: ITextStyle): TextStyleBuilder {
@@ -440,7 +440,7 @@ export class FUniver extends FBaseInitialable {
      * @returns {TextStyleValue} The new text style value instance
      * @example
      * ```ts
-     * const textStyleValue = univerApi.newTextStyleValue();
+     * const textStyleValue = univerAPI.newTextStyleValue();
      * ```
      */
     newTextStyleValue(style?: ITextStyle): TextStyleValue {
@@ -453,7 +453,7 @@ export class FUniver extends FBaseInitialable {
      * @returns {TextDecorationBuilder} The new text decoration instance
      * @example
      * ```ts
-     * const decoration = univerApi.newTextDecoration();
+     * const decoration = univerAPI.newTextDecoration();
      * ```
      */
     newTextDecoration(decoration?: ITextDecoration): TextDecorationBuilder {

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.