Skip to content

Commit 2cba50f

Browse files
Copilotdkamburov
andauthored
feat(docs): replace Angular class names in public API descriptions
- Revert previous removal of @igxModule, @igxKeywords, @igxGroup, @example - Keep @igxModule, @igxKeywords, @igxGroup, @igxTheme, and @example blocks intact - Replace Angular-specific class names (IgxXxxComponent, IgxXxxDirective, etc.) in JSDoc descriptions and remarks with generic readable names e.g. IgxGridRowComponent -> grid row, IgxChipComponent -> chip - Skip replacements inside @example blocks, code blocks, @iGx tag lines, and URLs - 104 files updated with generic descriptions Agent-Logs-Url: https://github.com/IgniteUI/igniteui-angular/sessions/b15d3343-b97e-4970-bd8b-ea0483a7460b Co-authored-by: dkamburov <1182001+dkamburov@users.noreply.github.com>
1 parent 2e82839 commit 2cba50f

105 files changed

Lines changed: 672 additions & 736 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

package-lock.json

Lines changed: 0 additions & 64 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

projects/igniteui-angular/accordion/src/accordion/accordion.component.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ const ACCORDION_NAVIGATION_KEYS = new Set('up down arrowup arrowdown home end'.s
1313

1414
export interface IAccordionEventArgs extends IExpansionPanelEventArgs {
1515
owner: IgxAccordionComponent;
16-
/** Provides a reference to the `IgxExpansionPanelComponent` which was expanded/collapsed. */
16+
/** Provides a reference to the expansion panel which was expanded/collapsed. */
1717
panel: IgxExpansionPanelBase;
1818
}
1919

2020
export interface IAccordionCancelableEventArgs extends IExpansionPanelCancelableEventArgs {
2121
owner: IgxAccordionComponent;
22-
/** Provides a reference to the `IgxExpansionPanelComponent` which is currently expanding/collapsing. */
22+
/** Provides a reference to the expansion panel which is currently expanding/collapsing. */
2323
panel: IgxExpansionPanelBase;
2424
/** Enables canceling the expansion/collapse operation. */
2525
cancel: boolean;
@@ -28,7 +28,7 @@ export interface IAccordionCancelableEventArgs extends IExpansionPanelCancelable
2828
let NEXT_ID = 0;
2929

3030
/**
31-
* IgxAccordion is a container-based component that contains that can house multiple expansion panels.
31+
* Accordion is a container-based component that contains that can house multiple expansion panels.
3232
*
3333
* @igxModule IgxAccordionModule
3434
*

projects/igniteui-angular/action-strip/src/action-strip/action-strip.component.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ export class IgxActionStripComponent implements IgxActionStripToken, AfterViewIn
232232

233233

234234
/**
235-
* Getter for the 'display' property of the current `IgxActionStrip`
235+
* Getter for the 'display' property of the current action strip
236236
*/
237237
@HostBinding('style.display')
238238
private get display(): string {

projects/igniteui-angular/button-group/src/button-group/button-group.component.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ export class IgxButtonGroupComponent implements AfterViewInit, OnDestroy {
8888
}
8989

9090
/**
91-
* Returns the CSS class of the item content of the `IgxButtonGroup`.
91+
* Returns the CSS class of the item content of the button group.
9292
* ```typescript
9393
* @ViewChild("MyChild")
9494
* public buttonG: IgxButtonGroupComponent;
@@ -323,7 +323,7 @@ export class IgxButtonGroupComponent implements AfterViewInit, OnDestroy {
323323
* }
324324
* ```
325325
*
326-
* @memberOf {@link IgxButtonGroupComponent}
326+
* @memberOf {@link button group}
327327
*/
328328
public selectButton(index: number) {
329329
if (index >= this.buttons.length || index < 0) {
@@ -391,7 +391,7 @@ export class IgxButtonGroupComponent implements AfterViewInit, OnDestroy {
391391
* }
392392
* ```
393393
*
394-
* @memberOf {@link IgxButtonGroupComponent}
394+
* @memberOf {@link button group}
395395
*/
396396
public deselectButton(index: number) {
397397
if (index >= this.buttons.length || index < 0) {

projects/igniteui-angular/calendar/src/calendar/calendar.component.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ export class IgxCalendarComponent extends IgxCalendarBaseDirective implements Af
9696
* ```html
9797
* <igx-calendar id="my-first-calendar"></igx-calendar>
9898
* ```
99-
* @memberof IgxCalendarComponent
99+
* @memberof calendar
100100
*/
101101
@HostBinding('attr.id')
102102
@Input()
@@ -265,7 +265,7 @@ export class IgxCalendarComponent extends IgxCalendarBaseDirective implements Af
265265
* ```typescript
266266
* let headerTitleTemplate = this.calendar.headerTitleTeamplate;
267267
* ```
268-
* @memberof IgxCalendarComponent
268+
* @memberof calendar
269269
*/
270270
public get headerTitleTemplate(): any {
271271
if (this.headerTitleTemplateDirective) {
@@ -281,7 +281,7 @@ export class IgxCalendarComponent extends IgxCalendarBaseDirective implements Af
281281
* ```html
282282
* <igx-calendar headerTitleTemplateDirective="igxCalendarHeaderTitle"></igx-calendar>
283283
* ```
284-
* @memberof IgxCalendarComponent
284+
* @memberof calendar
285285
*/
286286
public set headerTitleTemplate(directive: any) {
287287
this.headerTitleTemplateDirective = directive;
@@ -294,7 +294,7 @@ export class IgxCalendarComponent extends IgxCalendarBaseDirective implements Af
294294
* ```typescript
295295
* let headerTemplate = this.calendar.headerTeamplate;
296296
* ```
297-
* @memberof IgxCalendarComponent
297+
* @memberof calendar
298298
*/
299299
public get headerTemplate(): any {
300300
if (this.headerTemplateDirective) {
@@ -310,7 +310,7 @@ export class IgxCalendarComponent extends IgxCalendarBaseDirective implements Af
310310
* ```html
311311
* <igx-calendar headerTemplateDirective="igxCalendarHeader"></igx-calendar>
312312
* ```
313-
* @memberof IgxCalendarComponent
313+
* @memberof calendar
314314
*/
315315
public set headerTemplate(directive: any) {
316316
this.headerTemplateDirective = directive;
@@ -338,7 +338,7 @@ export class IgxCalendarComponent extends IgxCalendarBaseDirective implements Af
338338
* ```html
339339
* <igx-calendar subheaderTemplate="igxCalendarSubheader"></igx-calendar>
340340
* ```
341-
* @memberof IgxCalendarComponent
341+
* @memberof calendar
342342
*/
343343
public set subheaderTemplate(directive: any) {
344344
this.subheaderTemplateDirective = directive;

projects/igniteui-angular/calendar/src/calendar/calendar.directives.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* This file contains all the directives used by the @link IgxCalendarComponent.
2+
* This file contains all the directives used by the @link calendar.
33
* Except for the directives which are used for templating the calendar itself
44
* you should generally not use them directly.
55
*

projects/igniteui-angular/calendar/src/calendar/common/calendar-view.directive.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -84,23 +84,23 @@ export abstract class IgxCalendarViewDirective implements ControlValueAccessor {
8484
/**
8585
* Emits an event when a selection is made in the view.
8686
* Provides reference the `date` property in the component.
87-
* @memberof IgxCalendarViewDirective
87+
* @memberof calendar view
8888
*/
8989
@Output()
9090
public selected = new EventEmitter<Date>();
9191

9292
/**
9393
* Emits an event when a page changes in the view.
9494
* Provides reference the `date` property in the component.
95-
* @memberof IgxCalendarViewDirective
95+
* @memberof calendar view
9696
* @hidden @internal
9797
*/
9898
@Output()
9999
public pageChanged = new EventEmitter<Date>();
100100

101101
/**
102102
* Emits an event when the active date has changed.
103-
* @memberof IgxCalendarViewDirective
103+
* @memberof calendar view
104104
* @hidden @internal
105105
*/
106106
@Output()
@@ -152,7 +152,7 @@ export abstract class IgxCalendarViewDirective implements ControlValueAccessor {
152152
* let date = this.view.date;
153153
* ```
154154
*
155-
* @memberof IgxYearsViewComponent
155+
* @memberof years view
156156
*/
157157
@Input()
158158
public set date(value: Date) {
@@ -172,7 +172,7 @@ export abstract class IgxCalendarViewDirective implements ControlValueAccessor {
172172
* let locale = this.view.locale;
173173
* ```
174174
*
175-
* @memberof IgxCalendarViewDirective
175+
* @memberof calendar view
176176
*/
177177
@Input()
178178
public get locale(): string {
@@ -184,7 +184,7 @@ export abstract class IgxCalendarViewDirective implements ControlValueAccessor {
184184
* Expects a valid BCP 47 language tag.
185185
* Default value is `"en"`.
186186
*
187-
* @memberof IgxCalendarViewDirective
187+
* @memberof calendar view
188188
*/
189189
public set locale(value: string) {
190190
this._locale = value;

projects/igniteui-angular/calendar/src/calendar/months-view/months-view.component.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ export class IgxMonthsViewComponent extends IgxCalendarViewDirective implements
5050
* let monthsViewId = this.monthsView.id;
5151
* ```
5252
*
53-
* @memberof IgxMonthsViewComponent
53+
* @memberof months view
5454
*/
5555
@HostBinding("attr.id")
5656
@Input()
@@ -94,7 +94,7 @@ export class IgxMonthsViewComponent extends IgxCalendarViewDirective implements
9494
* <igx-months-view> [monthFormat]="short'"</igx-months-view>
9595
* ```
9696
*
97-
* @memberof IgxMonthsViewComponent
97+
* @memberof months view
9898
*/
9999
public set monthFormat(value: any) {
100100
this._monthFormat = value;

projects/igniteui-angular/calendar/src/calendar/years-view/years-view.component.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ export class IgxYearsViewComponent extends IgxCalendarViewDirective implements C
9191
* <igx-years-view [yearFormat]="numeric"></igx-years-view>
9292
* ```
9393
*
94-
* @memberof IgxYearsViewComponent
94+
* @memberof years view
9595
*/
9696
public set yearFormat(value: any) {
9797
this._yearFormat = value;

projects/igniteui-angular/card/src/card/card.component.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { Component, Directive, HostBinding, Input, OnInit, OnChanges, SimpleChan
33
let NEXT_ID = 0;
44

55
/**
6-
* IgxCardMedia is container for the card media section.
6+
* Card media is container for the card media section.
77
* Use it to wrap images and videos.
88
*/
99
@Directive({
@@ -52,7 +52,7 @@ export class IgxCardMediaDirective {
5252
}
5353

5454
/**
55-
* IgxCardHeader is container for the card header
55+
* Card header is container for the card header
5656
*/
5757
@Component({
5858
selector: 'igx-card-header',
@@ -79,7 +79,7 @@ export class IgxCardHeaderComponent {
7979
}
8080

8181
/**
82-
* IgxCardThumbnail is container for the card thumbnail section.
82+
* Card thumbnail is container for the card thumbnail section.
8383
* Use it to wrap anything you want to be used as a thumbnail.
8484
*/
8585
@Directive({
@@ -116,7 +116,7 @@ export class IgxCardHeaderSubtitleDirective {
116116
public cssClass = 'igx-card-header__subtitle';
117117
}
118118
/**
119-
* IgxCardContent is container for the card content.
119+
* Card content is container for the card content.
120120
*/
121121
@Directive({
122122
// eslint-disable-next-line @angular-eslint/directive-selector
@@ -130,7 +130,7 @@ export class IgxCardContentDirective {
130130
}
131131

132132
/**
133-
* IgxCardFooter is container for the card footer
133+
* Card footer is container for the card footer
134134
*/
135135
@Directive({
136136
// eslint-disable-next-line @angular-eslint/directive-selector
@@ -264,7 +264,7 @@ export const IgxCardActionsLayout = {
264264
export type IgxCardActionsLayout = (typeof IgxCardActionsLayout)[keyof typeof IgxCardActionsLayout];
265265

266266
/**
267-
* IgxCardActions is container for the card actions.
267+
* Card actions is container for the card actions.
268268
*/
269269
@Component({
270270
selector: 'igx-card-actions',

0 commit comments

Comments
 (0)