Skip to content

Commit 329bc77

Browse files
authored
Merge pull request #6890 from IgniteUI/tslint-jsdoc-format
feat(*): enable jsdoc-formatting rule
2 parents 69f37d7 + 845803d commit 329bc77

File tree

103 files changed

+1869
-1850
lines changed

Some content is hidden

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

103 files changed

+1869
-1850
lines changed

package-lock.json

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

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
"gulp-util": "^3.0.8",
9292
"hammer-simulator": "0.0.1",
9393
"igniteui-sassdoc-theme": "^1.1.2",
94-
"igniteui-typedoc-theme": "^1.3.1",
94+
"igniteui-typedoc-theme": "^1.3.2",
9595
"jasmine": "~3.4.0",
9696
"jasmine-core": "~3.4.0",
9797
"jasmine-spec-reporter": "~4.2.1",

projects/igniteui-angular/src/lib/avatar/avatar.component.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,9 @@ export class IgxAvatarComponent implements OnInit {
159159
* Sets the color of the avatar's initials or icon.
160160
*
161161
* @example
162-
*```html
163-
*<igx-avatar color="blue"></igx-avatar>
164-
*```
162+
* ```html
163+
* <igx-avatar color="blue"></igx-avatar>
164+
* ```
165165
*/
166166

167167
@HostBinding('style.color')

projects/igniteui-angular/src/lib/badge/badge.component.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export enum IgxBadgeType {
4242
})
4343
export class IgxBadgeComponent {
4444

45-
/**
45+
/**
4646
* Sets/gets the `id` of the badge.
4747
*
4848
* @remarks
@@ -57,7 +57,7 @@ export class IgxBadgeComponent {
5757
@Input()
5858
public id = `igx-badge-${NEXT_ID++}`;
5959

60-
/**
60+
/**
6161
* Sets/gets the type of the badge.
6262
*
6363
* @remarks
@@ -72,7 +72,7 @@ export class IgxBadgeComponent {
7272
@Input()
7373
public type: string | IgxBadgeType = IgxBadgeType.PRIMARY;
7474

75-
/**
75+
/**
7676
* Sets/gets the value to be displayed inside the badge.
7777
*
7878
* @remarks

projects/igniteui-angular/src/lib/buttonGroup/buttonGroup.component.ts

Lines changed: 67 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -88,27 +88,27 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
8888
/**
8989
* Allows you to set a style using the `itemContentCssClass` input.
9090
* The value should be the CSS class name that will be applied to the button group.
91-
*```typescript
92-
*public style1 = "styleClass";
93-
* //..
94-
*```
95-
* ```html
96-
*<igx-buttongroup [itemContentCssClass]="style1" [multiSelection]="!multi" [values]="alignOptions">
97-
*```
91+
* ```typescript
92+
* public style1 = "styleClass";
93+
* //..
94+
* ```
95+
* ```html
96+
* <igx-buttongroup [itemContentCssClass]="style1" [multiSelection]="!multi" [values]="alignOptions">
97+
* ```
9898
*/
9999
@Input() set itemContentCssClass(value: string) {
100100
this._itemContentCssClass = value || this._itemContentCssClass;
101101
}
102102

103103
/**
104104
* Returns the CSS class of the item content of the `IgxButtonGroup`.
105-
*```typescript
106-
*@ViewChild("MyChild")
107-
*public buttonG: IgxButtonGroupComponent;
108-
*ngAfterViewInit(){
109-
* let buttonSelect = this.buttonG.itemContentCssClass;
110-
*}
111-
*```
105+
* ```typescript
106+
* @ViewChild("MyChild")
107+
* public buttonG: IgxButtonGroupComponent;
108+
* ngAfterViewInit(){
109+
* let buttonSelect = this.buttonG.itemContentCssClass;
110+
* }
111+
* ```
112112
*/
113113
get itemContentCssClass(): string {
114114
return this._itemContentCssClass;
@@ -177,61 +177,61 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
177177
* Allows you to set the button group alignment.
178178
* Available options are `ButtonGroupAlignment.horizontal` (default) and `ButtonGroupAlignment.vertical`.
179179
* ```typescript
180-
*public alignment = ButtonGroupAlignment.vertical;
180+
* public alignment = ButtonGroupAlignment.vertical;
181181
* //..
182182
* ```
183183
* ```html
184-
*<igx-buttongroup [multiSelection]="false" [values]="cities" [alignment]="alignment"></igx-buttongroup>
184+
* <igx-buttongroup [multiSelection]="false" [values]="cities" [alignment]="alignment"></igx-buttongroup>
185185
* ```
186186
*/
187187
@Input() set alignment(value: ButtonGroupAlignment) {
188188
this._isVertical = value === ButtonGroupAlignment.vertical;
189189
}
190190
/**
191191
* Returns the alignment of the `igx-buttongroup`.
192-
*```typescript
193-
*@ViewChild("MyChild")
194-
*public buttonG: IgxButtonGroupComponent;
195-
*ngAfterViewInit(){
192+
* ```typescript
193+
* @ViewChild("MyChild")
194+
* public buttonG: IgxButtonGroupComponent;
195+
* ngAfterViewInit(){
196196
* let buttonAlignment = this.buttonG.alignment;
197-
*}
198-
*```
197+
* }
198+
* ```
199199
*/
200200
get alignment(): ButtonGroupAlignment {
201201
return this._isVertical ? ButtonGroupAlignment.vertical : ButtonGroupAlignment.horizontal;
202202
}
203203

204204
/**
205205
* An @Ouput property that emits an event when a button is selected.
206-
*```typescript
207-
*@ViewChild("toast")
208-
*private toast: IgxToastComponent;
209-
*public onSelect(buttongroup){
210-
* this.toast.show()
211-
*}
212-
* //...
213-
*```
214-
*```html
206+
* ```typescript
207+
* @ViewChild("toast")
208+
* private toast: IgxToastComponent;
209+
* public onSelect(buttongroup){
210+
* this.toast.show()
211+
* }
212+
* //...
213+
* ```
214+
* ```html
215215
* <igx-buttongroup #MyChild [multiSelection]="!multi" (onSelect)="onSelect($event)"></igx-buttongroup>
216-
*<igx-toast #toast message="You have made a selection!"></igx-toast>
217-
*```
216+
* <igx-toast #toast message="You have made a selection!"></igx-toast>
217+
* ```
218218
*/
219219
@Output() public onSelect = new EventEmitter<IButtonGroupEventArgs>();
220220

221221
/**
222222
* An @Ouput property that emits an event when a button is deselected.
223-
*```typescript
224-
*@ViewChild("toast")
225-
*private toast: IgxToastComponent;
226-
*public onUnselect(buttongroup){
227-
* this.toast.show()
228-
*}
229-
* //...
230-
*```
231-
*```html
232-
* igx-buttongroup #MyChild [multiSelection]="multi" (onUnselect)="onUnselect($event)"></igx-buttongroup>
233-
*<igx-toast #toast message="You have deselected a button!"></igx-toast>
234-
*```
223+
* ```typescript
224+
* @ViewChild("toast")
225+
* private toast: IgxToastComponent;
226+
* public onUnselect(buttongroup){
227+
* this.toast.show()
228+
* }
229+
* //...
230+
* ```
231+
* ```html
232+
* <igx-buttongroup> #MyChild [multiSelection]="multi" (onUnselect)="onUnselect($event)"></igx-buttongroup>
233+
* <igx-toast #toast message="You have deselected a button!"></igx-toast>
234+
* ```
235235
*/
236236
@Output() public onUnselect = new EventEmitter<IButtonGroupEventArgs>();
237237

@@ -243,12 +243,12 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
243243
* ```
244244
* ```typescript
245245
* //...
246-
*@ViewChild("MyChild")
247-
*private buttonG: IgxButtonGroupComponent;
248-
*ngAfterViewInit(){
246+
* @ViewChild("MyChild")
247+
* private buttonG: IgxButtonGroupComponent;
248+
* ngAfterViewInit(){
249249
* let orientation = this.buttonG.isVertical;
250-
*}
251-
*```
250+
* }
251+
* ```
252252
*/
253253
public get isVertical(): boolean {
254254
return this._isVertical;
@@ -263,13 +263,13 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
263263

264264
/**
265265
* Gets the selected button/buttons.
266-
*```typescript
267-
*@ViewChild("MyChild")
268-
*private buttonG: IgxButtonGroupComponent;
269-
*ngAfterViewInit(){
266+
* ```typescript
267+
* @ViewChild("MyChild")
268+
* private buttonG: IgxButtonGroupComponent;
269+
* ngAfterViewInit(){
270270
* let selectedButton = this.buttonG.selectedButtons;
271-
*}
272-
*```
271+
* }
272+
* ```
273273
*/
274274
get selectedButtons(): IgxButtonDirective[] {
275275
return this.buttons.filter((b, i) => {
@@ -280,14 +280,14 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
280280

281281
/**
282282
* Selects a button by its index.
283-
*```typescript
284-
*@ViewChild("MyChild")
285-
*private buttonG: IgxButtonGroupComponent;
286-
*ngAfterViewInit(){
283+
* ```typescript
284+
* @ViewChild("MyChild")
285+
* private buttonG: IgxButtonGroupComponent;
286+
* ngAfterViewInit(){
287287
* this.buttonG.selectButton(2);
288288
* this.cdr.detectChanges();
289-
*}
290-
*```
289+
* }
290+
* ```
291291
* @memberOf {@link IgxButtonGroupComponent}
292292
*/
293293
public selectButton(index: number) {
@@ -324,12 +324,12 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
324324
/**
325325
* Deselects a button by its index.
326326
* ```typescript
327-
*@ViewChild("MyChild")
328-
*private buttonG: IgxButtonGroupComponent;
329-
*ngAfterViewInit(){
327+
* @ViewChild("MyChild")
328+
* private buttonG: IgxButtonGroupComponent;
329+
* ngAfterViewInit(){
330330
* this.buttonG.deselectButton(2);
331331
* this.cdr.detectChanges();
332-
*}
332+
* }
333333
* ```
334334
* @memberOf {@link IgxButtonGroupComponent}
335335
*/
@@ -412,7 +412,7 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
412412
}
413413

414414
/**
415-
*@hidden
415+
* @hidden
416416
*/
417417
public _clickHandler(event, i) {
418418
if (this.selectedIndexes.indexOf(i) !== -1) {

0 commit comments

Comments
 (0)