Skip to content

Commit 12c6fe9

Browse files
chore: ignore -> hidden, analyzer suppress & omitModule tags (#2278)
Co-authored-by: Ivan Minchev <61944284+IMinchev64@users.noreply.github.com>
1 parent 99eb64d commit 12c6fe9

16 files changed

Lines changed: 25 additions & 16 deletions

File tree

src/components/button/button-base.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ export interface IgcButtonEventMap {
1919
blur: FocusEvent;
2020
}
2121

22+
/* omitModule */
2223
/**
2324
* Abstract base class shared by `igc-button` and `igc-icon-button`.
2425
*
@@ -156,7 +157,7 @@ export abstract class IgcButtonBaseComponent extends EventEmitterMixin<
156157
return this._commandfor;
157158
}
158159

159-
/* blazorCSSuppress */
160+
/* blazorSuppress */
160161
/* alternateType: object */
161162
/**
162163
* The target element for the invoker command. Resolved from the `commandfor` ID.
@@ -165,7 +166,7 @@ export abstract class IgcButtonBaseComponent extends EventEmitterMixin<
165166
return this._commandForElement;
166167
}
167168

168-
/* blazorCSSuppress */
169+
/* blazorSuppress */
169170
/* alternateType: object */
170171
public set commandForElement(value: Element | null) {
171172
this._commandForElement = value;

src/components/chat/types.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,11 +198,10 @@ export interface IgcChatMessageReaction {
198198
reaction: string;
199199
}
200200

201-
/* blazorSuppress */
202201
/**
203-
* @ignore
204202
* A collection of optional rendering functions that allow for custom UI rendering.
205203
* Each property is a function that takes a context object and returns a template result.
204+
* @hidden
206205
*/
207206
export interface ChatRenderers {
208207
/**

src/components/common/controllers/gestures.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const defaultState: GestureState = Object.freeze({ x: 0, y: 0, time: 0 });
1212

1313
/**
1414
* Configuration object for a {@link GesturesController} instance.
15-
* @ignore
15+
* @hidden
1616
*/
1717
export interface GesturesOptions {
1818
/**

src/components/common/controllers/key-bindings.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ type KeyBindingTrigger = 'keydown' | 'keyup';
5656

5757
/**
5858
* Configuration object for the controller.
59-
* @ignore
59+
* @hidden
6060
*/
6161
interface KeyBindingControllerOptions {
6262
/**
@@ -124,6 +124,7 @@ interface KeyBindingOptions {
124124
stopPropagation?: boolean;
125125
}
126126

127+
/** @hidden */
127128
interface KeyBinding {
128129
keys: string[];
129130
handler: KeyBindingHandler;
@@ -184,7 +185,7 @@ function createCombinationKey(keys: string[], modifiers: string[]): string {
184185
*
185186
* The controller listens for keyboard events on the host element (or an optionally specified element) and invokes the appropriate handlers
186187
* when the registered key combinations are detected.
187-
*
188+
* @hidden
188189
*/
189190
class KeyBindingController implements ReactiveController {
190191
//#region Private properties and state

src/components/common/controllers/mutation-observer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import {
55
} from 'lit';
66
import { isElement } from '../util.js';
77

8-
/** @ignore */
8+
/** @hidden */
99
export interface MutationControllerConfig<T extends Node = Node> {
1010
/** The callback function to run when a mutation occurs. */
1111
callback: MutationControllerCallback<T>;

src/components/common/controllers/resize-observer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ type ResizeObserverControllerCallback = (
1010

1111
/**
1212
* Configuration for initializing a resize controller.
13-
* @ignore
13+
* @hidden
1414
*/
1515
export interface ResizeObserverControllerConfig {
1616
/** The callback function to run when a resize mutation is triggered. */

src/components/common/mixins/alert.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import { addCommandController } from '../controllers/command.js';
77
import { addInternalsController } from '../controllers/internals.js';
88
import { getVisibleAncestor, isPopoverOpen } from '../util.js';
99

10+
/* omitModule */
1011
export abstract class IgcBaseAlertLikeComponent extends LitElement {
1112
protected readonly _player = addAnimationController(this);
1213

src/components/common/mixins/option.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { html, LitElement } from 'lit';
22
import { property, queryAssignedNodes } from 'lit/decorators.js';
33
import { addInternalsController } from '../controllers/internals.js';
44

5+
/* omitModule */
56
export abstract class IgcBaseOptionLikeComponent extends LitElement {
67
protected readonly _internals = addInternalsController(this, {
78
initialARIA: { role: 'option' },

src/components/common/validators.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import {
1111
type ValidatorHandler<T> = (host: T) => boolean;
1212
type ValidatorMessageFormat<T> = (host: T) => string;
1313

14-
/** @ignore */
14+
/** @hidden */
1515
export interface Validator<T = any> {
1616
key: keyof ValidityStateFlags;
1717
message: string | ValidatorMessageFormat<T>;

src/components/date-range-picker/date-range-mask-parser.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ import type { DateRangeValue } from '../types.js';
1515
//#region Types and Enums
1616

1717
/**
18-
* @ignore
18+
* @hidden
1919
*/
2020
export interface DateRangePart {
2121
part: DatePart;
2222
position: DateRangePosition;
2323
}
2424

2525
/**
26-
* @ignore
2726
* Position of a date part within the date range
27+
* @hidden
2828
*/
2929
export enum DateRangePosition {
3030
Start = 'start',
@@ -33,8 +33,8 @@ export enum DateRangePosition {
3333
}
3434

3535
/**
36-
* @ignore
3736
* Extended date part with range position information
37+
* @hidden
3838
*/
3939
export interface IDateRangePart extends IDatePart {
4040
position: DateRangePosition;

0 commit comments

Comments
 (0)