feat: cleanup jsdoc (#4553)

dream-num · Jan 23, 2025 · 31a8aa8 · 31a8aa8
1 parent 99127d7
commit 31a8aa8
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 0 deletions.
diff --git a/common/shared/vite/index.ts b/common/shared/vite/index.ts
@@ -76,6 +76,7 @@ async function buildESM(sharedConfig: InlineConfig, options: IBuildExecuterOptio
                     entryRoot: 'src',
                     outDir: 'lib/types',
                     clearPureImport: false,
+                    exclude: ['**/__tests__/**'],
                 })
             );
         }

diff --git a/packages/core/src/facade/f-enum.ts b/packages/core/src/facade/f-enum.ts
@@ -43,6 +43,9 @@ import { ThemeColorType } from '../types/enum/theme-color-type';
  * @hideconstructor
  */
 export class FEnum {
+    /**
+     * @ignore
+     */
     static _instance: FEnum | null;
 
     static get() {

diff --git a/packages/core/src/facade/f-event.ts b/packages/core/src/facade/f-event.ts
@@ -87,7 +87,11 @@ export interface ICommandEvent extends IEventBase {
  * @hideconstructor
  */
 export class FEventName {
+    /**
+     * @ignore
+     */
     static _instance: FEventName | null;
+
     static get() {
         if (this._instance) {
             return this._instance;

diff --git a/packages/core/src/facade/f-util.ts b/packages/core/src/facade/f-util.ts
@@ -20,7 +20,11 @@ import { numfmt, Rectangle, Tools } from '../shared';
  * @ignore
  */
 export class FUtil {
+    /**
+     * @ignore
+     */
     static _instance: FUtil | null;
+
     static get() {
         if (this._instance) {
             return this._instance;

diff --git a/packages/sheets-conditional-formatting/src/facade/conditional-formatting-builder.ts b/packages/sheets-conditional-formatting/src/facade/conditional-formatting-builder.ts
@@ -22,6 +22,7 @@ import { BooleanNumber, ColorKit, Tools } from '@univerjs/core';
 import { CFNumberOperator, CFRuleType, CFSubRuleType, CFTextOperator, CFValueType, createCfId, EMPTY_ICON_TYPE, iconMap } from '@univerjs/sheets-conditional-formatting';
 
 /**
+ * @ignore
  * @hideconstructor
  */
 class ConditionalFormatRuleBaseBuilder {

diff --git a/packages/sheets-data-validation/src/facade/f-univer.ts b/packages/sheets-data-validation/src/facade/f-univer.ts
@@ -245,6 +245,9 @@ export class FUnvierDataValidationMixin extends FUniver {
 
 FUniver.extend(FUnvierDataValidationMixin);
 declare module '@univerjs/core' {
+    /**
+     * @ignore
+     */
     // eslint-disable-next-line ts/no-namespace
     namespace FUniver {
         function newDataValidation(): FDataValidationBuilder;

diff --git a/packages/sheets/src/facade/f-workbook.ts b/packages/sheets/src/facade/f-workbook.ts
@@ -883,6 +883,9 @@ export class FWorkbook extends FBaseInitialable {
     }
 }
 
+/**
+ * @ignore
+ */
 // eslint-disable-next-line ts/no-namespace
 export namespace FWorkbook {
     export type FontLine = _FontLine;