chore: Fixed typedoc warnings and internal exports showing in API docs (#2259)

Author: rkaraivanov

scripts/build-typedoc.js

@@ -2,7 +2,7 @@ import { watch as fsWatch } from 'node:fs';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { createServer } from 'vite';
-import { Application } from 'typedoc';
+import { Application, OptionDefaults } from 'typedoc';
 import report from './report.mjs';
 
 const __filename = fileURLToPath(import.meta.url);
@@ -108,6 +108,15 @@ async function main() {
     router: 'kind',
     excludePrivate: true,
     excludeProtected: true,
+    blockTags: [
+      ...OptionDefaults.blockTags,
+      '@element',
+      '@slot',
+      '@fires',
+      '@csspart',
+      '@cssproperty',
+      '@attr',
+    ],
     suppressCommentWarningsInDeclarationFiles: true,
     name: 'Ignite UI for Web Components',
     readme: 'none',
@@ -139,7 +148,7 @@ async function main() {
       await app.generateDocs(project, TYPEDOC.OUTPUT);
       await serve();
       break;
-    case 'default':
+    default:
       throw new Error('Unrecognized action argument');
   }
 }

src/components/combo/combo.ts

@@ -438,10 +438,6 @@ export default class IgcComboComponent<
   /**
    * An object that configures the filtering of the combo.
    * @attr filtering-options
-   * @type {FilteringOptions<T>}
-   * @param filterKey - The key in the data source used when filtering the list of options.
-   * @param caseSensitive - Determines whether the filtering operation should be case sensitive.
-   * @param matchDiacritics -If true, the filter distinguishes between accented letters and their base letters.
    */
   @property({ type: Object, attribute: 'filtering-options' })
   public set filteringOptions(value: Partial<FilteringOptions<T>>) {

src/components/combo/types.ts

@@ -24,9 +24,13 @@ export type ComboRenderFunction<T extends object> = RenderItemFunction<
 export type ComboValue<T> = T | Values<T>;
 
 /* jsonAPIPlainObject */
+/** Filtering options for the combo component. */
 export interface FilteringOptions<T extends object> {
+  /** The key in the data source used when filtering the list of options. */
   filterKey: Keys<T> | undefined;
+  /** Determines whether the filtering operation should be case sensitive. */
   caseSensitive?: boolean;
+  /** If true, the filter distinguishes between accented letters and their base letters */
   matchDiacritics?: boolean;
 }
 

src/index.ts

@@ -87,8 +87,6 @@ export {
 // theming configuration
 export { configureTheme } from './theming/config.js';
 export type { Theme, ThemeVariant } from './theming/types.js';
-export { addThemingController as θaddThemingController } from './theming/theming-controller.js';
-export { addAdoptedStylesController as θaddAdoptedStylesController } from './components/common/controllers/adopt-styles.js';
 
 // localization objects
 export {
@@ -199,3 +197,13 @@ export type {
 } from './components/combo/types.js';
 export type { IconMeta } from './components/icon/registry/types.js';
 export type * from './components/chat/types.js';
+
+// Internal exports for other packages
+/** @ignore */
+export { addThemingController as θaddThemingController } from './theming/theming-controller.js';
+
+/** @ignore */
+export { addAdoptedStylesController as θaddAdoptedStylesController } from './components/common/controllers/adopt-styles.js';
+
+/** @ignore */
+export { createAbortHandle as θcreateAbortHandle } from './components/common/abort-handler.js';

tsconfig.json

@@ -44,6 +44,7 @@
     "excludePrivate": true,
     "excludeProtected": true,
     "excludeExternals": true,
+    "excludeNotDocumented": true,
     "name": "Ignite UI for Web Components",
     "readme": "none"
   }