Skip to content

Commit 35bf50e

Browse files
Copilotdkamburov
andcommitted
feat(docs): remove Angular-specific items from public API docs
- Remove @igxModule, @igxTheme, @igxKeywords, @igxGroup, @igxFriendlyName, @igxParent, @igxElementsAnchor tags from JSDoc comments across 171 files - Remove all @example code blocks (HTML templates and TypeScript snippets) - Remove standalone code blocks from descriptions and @remarks sections - Remove bare HTML elements (igx- tags) from JSDoc descriptions - Replace inline selector references with plain text names in component descriptions - Build and tests verified to pass Co-authored-by: dkamburov <1182001+dkamburov@users.noreply.github.com>
1 parent d6f61c7 commit 35bf50e

172 files changed

Lines changed: 8 additions & 10147 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: 0 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,10 @@ let NEXT_ID = 0;
3030
/**
3131
* IgxAccordion is a container-based component that contains that can house multiple expansion panels.
3232
*
33-
* @igxModule IgxAccordionModule
34-
*
35-
* @igxKeywords accordion
36-
*
37-
* @igxGroup Layouts
38-
*
3933
* @remarks
4034
* The Ignite UI for Angular Accordion component enables the user to navigate among multiple collapsing panels
4135
* displayed in a single container.
4236
* The accordion offers keyboard navigation and API to control the underlying panels' expansion state.
43-
*
44-
* @example
45-
* ```html
46-
* <igx-accordion>
47-
* <igx-expansion-panel *ngFor="let panel of panels">
48-
* ...
49-
* </igx-expansion-panel>
50-
* </igx-accordion>
51-
* ```
5237
*/
5338
@Component({
5439
selector: 'igx-accordion',
@@ -61,12 +46,6 @@ export class IgxAccordionComponent implements AfterContentInit, AfterViewInit, O
6146
/**
6247
* Get/Set the `id` of the accordion component.
6348
* Default value is `"igx-accordion-0"`;
64-
* ```html
65-
* <igx-accordion id="my-first-accordion"></igx-accordion>
66-
* ```
67-
* ```typescript
68-
* const accordionId = this.accordion.id;
69-
* ```
7049
*/
7150
@HostBinding('attr.id')
7251
@Input()
@@ -82,19 +61,6 @@ export class IgxAccordionComponent implements AfterContentInit, AfterViewInit, O
8261

8362
/**
8463
* Get/Set the animation settings that panels should use when expanding/collpasing.
85-
*
86-
* ```html
87-
* <igx-accordion [animationSettings]="customAnimationSettings"></igx-accordion>
88-
* ```
89-
*
90-
* ```typescript
91-
* const customAnimationSettings: ToggleAnimationSettings = {
92-
* openAnimation: growVerIn,
93-
* closeAnimation: growVerOut
94-
* };
95-
*
96-
* this.accordion.animationSettings = customAnimationSettings;
97-
* ```
9864
*/
9965
@Input()
10066
public get animationSettings(): ToggleAnimationSettings {
@@ -109,16 +75,6 @@ export class IgxAccordionComponent implements AfterContentInit, AfterViewInit, O
10975
/**
11076
* Get/Set how the accordion handles the expansion of the projected expansion panels.
11177
* If set to `true`, only a single panel can be expanded at a time, collapsing all others
112-
*
113-
* ```html
114-
* <igx-accordion [singleBranchExpand]="true">
115-
* ...
116-
* </igx-accordion>
117-
* ```
118-
*
119-
* ```typescript
120-
* this.accordion.singleBranchExpand = false;
121-
* ```
12278
*/
12379
@Input({ transform: booleanAttribute })
12480
public get singleBranchExpand(): boolean {
@@ -137,38 +93,12 @@ export class IgxAccordionComponent implements AfterContentInit, AfterViewInit, O
13793
*
13894
* @remarks
13995
* This event is cancelable.
140-
*
141-
* ```html
142-
* <igx-accordion (panelExpanding)="handlePanelExpanding($event)">
143-
* </igx-accordion>
144-
* ```
145-
*
146-
*```typescript
147-
* public handlePanelExpanding(event: IExpansionPanelCancelableEventArgs){
148-
* const expandedPanel: IgxExpansionPanelComponent = event.panel;
149-
* if (expandedPanel.disabled) {
150-
* event.cancel = true;
151-
* }
152-
* }
153-
*```
15496
*/
15597
@Output()
15698
public panelExpanding = new EventEmitter<IAccordionCancelableEventArgs>();
15799

158100
/**
159101
* Emitted after a panel has been expanded.
160-
*
161-
* ```html
162-
* <igx-accordion (panelExpanded)="handlePanelExpanded($event)">
163-
* </igx-accordion>
164-
* ```
165-
*
166-
*```typescript
167-
* public handlePanelExpanded(event: IExpansionPanelCancelableEventArgs) {
168-
* const expandedPanel: IgxExpansionPanelComponent = event.panel;
169-
* console.log("Panel is expanded: ", expandedPanel.id);
170-
* }
171-
*```
172102
*/
173103
@Output()
174104
public panelExpanded = new EventEmitter<IAccordionEventArgs>();
@@ -178,32 +108,18 @@ export class IgxAccordionComponent implements AfterContentInit, AfterViewInit, O
178108
*
179109
* @remarks
180110
* This event is cancelable.
181-
*
182-
* ```html
183-
* <igx-accordion (panelCollapsing)="handlePanelCollapsing($event)">
184-
* </igx-accordion>
185-
* ```
186111
*/
187112
@Output()
188113
public panelCollapsing = new EventEmitter<IAccordionCancelableEventArgs>();
189114

190115
/**
191116
* Emitted after a panel has been collapsed.
192-
*
193-
* ```html
194-
* <igx-accordion (panelCollapsed)="handlePanelCollapsed($event)">
195-
* </igx-accordion>
196-
* ```
197117
*/
198118
@Output()
199119
public panelCollapsed = new EventEmitter<IAccordionEventArgs>();
200120

201121
/**
202122
* Get all panels.
203-
*
204-
* ```typescript
205-
* const panels: IgxExpansionPanelComponent[] = this.accordion.panels;
206-
* ```
207123
*/
208124
public get panels(): IgxExpansionPanelComponent[] {
209125
return this._panels?.toArray();
@@ -247,10 +163,6 @@ export class IgxAccordionComponent implements AfterContentInit, AfterViewInit, O
247163

248164
/**
249165
* Expands all collapsed expansion panels.
250-
*
251-
* ```typescript
252-
* accordion.expandAll();
253-
* ```
254166
*/
255167
public expandAll(): void {
256168
if (this.singleBranchExpand) {
@@ -266,10 +178,6 @@ export class IgxAccordionComponent implements AfterContentInit, AfterViewInit, O
266178

267179
/**
268180
* Collapses all expanded expansion panels.
269-
*
270-
* ```typescript
271-
* accordion.collapseAll();
272-
* ```
273181
*/
274182
public collapseAll(): void {
275183
this.panels.forEach(panel => panel.collapse());

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

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -57,25 +57,9 @@ export class IgxActionStripMenuItemDirective {
5757
/**
5858
* Action Strip provides templatable area for one or more actions.
5959
*
60-
* @igxModule IgxActionStripModule
61-
*
62-
* @igxTheme igx-action-strip-theme
63-
*
64-
* @igxKeywords action, strip, actionStrip, pinning, editing
65-
*
66-
* @igxGroup Data Entry & Display
67-
*
68-
* @igxParent IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxRowIslandComponent, *
69-
*
7060
* @remarks
7161
* The Ignite UI Action Strip is a container, overlaying its parent container,
7262
* and displaying action buttons with action applicable to the parent component the strip is instantiated or shown for.
73-
*
74-
* @example
75-
* ```html
76-
* <igx-action-strip #actionStrip>
77-
* <igx-icon (click)="doSomeAction()"></igx-icon>
78-
* </igx-action-strip>
7963
*/
8064
@Component({
8165
selector: 'igx-action-strip',
@@ -105,11 +89,6 @@ export class IgxActionStripComponent implements IgxActionStripToken, AfterViewIn
10589
* Sets the context of an action strip.
10690
* The context should be an instance of a @Component, that has element property.
10791
* This element will be the placeholder of the action strip.
108-
*
109-
* @example
110-
* ```html
111-
* <igx-action-strip [context]="cell"></igx-action-strip>
112-
* ```
11392
*/
11493
@Input()
11594
public context: any;
@@ -140,11 +119,6 @@ export class IgxActionStripComponent implements IgxActionStripToken, AfterViewIn
140119
/**
141120
* Gets/Sets the visibility of the Action Strip.
142121
* Could be used to set if the Action Strip will be initially hidden.
143-
*
144-
* @example
145-
* ```html
146-
* <igx-action-strip [hidden]="false">
147-
* ```
148122
*/
149123
@Input({ transform: booleanAttribute })
150124
public hidden = true;
@@ -285,10 +259,6 @@ export class IgxActionStripComponent implements IgxActionStripToken, AfterViewIn
285259
* Showing the Action Strip and appending it the specified context element.
286260
*
287261
* @param context
288-
* @example
289-
* ```typescript
290-
* this.actionStrip.show(row);
291-
* ```
292262
*/
293263
public show(context?: any): void {
294264
this.hidden = false;
@@ -308,11 +278,6 @@ export class IgxActionStripComponent implements IgxActionStripToken, AfterViewIn
308278

309279
/**
310280
* Hiding the Action Strip and removing it from its current context element.
311-
*
312-
* @example
313-
* ```typescript
314-
* this.actionStrip.hide();
315-
* ```
316281
*/
317282
public hide(): void {
318283
this.hidden = true;

0 commit comments

Comments
 (0)