Merge pull request #6890 from IgniteUI/tslint-jsdoc-format

feat(*): enable jsdoc-formatting rule

Author: zdrawku

package-lock.json

@@ -91,7 +91,7 @@
     "gulp-util": "^3.0.8",
     "hammer-simulator": "0.0.1",
     "igniteui-sassdoc-theme": "^1.1.2",
-    "igniteui-typedoc-theme": "^1.3.1",
+    "igniteui-typedoc-theme": "^1.3.2",
     "jasmine": "~3.4.0",
     "jasmine-core": "~3.4.0",
     "jasmine-spec-reporter": "~4.2.1",

package.json

@@ -159,9 +159,9 @@ export class IgxAvatarComponent implements OnInit {
      * Sets the color of the avatar's initials or icon.
      *
      * @example
-     *```html
-     *<igx-avatar color="blue"></igx-avatar>
-     *```
+     * ```html
+     * <igx-avatar color="blue"></igx-avatar>
+     * ```
      */
 
     @HostBinding('style.color')

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

@@ -42,7 +42,7 @@ export enum IgxBadgeType {
 })
 export class IgxBadgeComponent {
 
-    /**
+   /**
     * Sets/gets the `id` of the badge.
     *
     * @remarks
@@ -57,7 +57,7 @@ export class IgxBadgeComponent {
     @Input()
     public id = `igx-badge-${NEXT_ID++}`;
 
-    /**
+   /**
     * Sets/gets the type of the badge.
     *
     * @remarks
@@ -72,7 +72,7 @@ export class IgxBadgeComponent {
     @Input()
     public type: string | IgxBadgeType = IgxBadgeType.PRIMARY;
 
-    /**
+   /**
     * Sets/gets the value to be displayed inside the badge.
     *
     * @remarks

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

@@ -88,27 +88,27 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
     /**
      * Allows you to set a style using the `itemContentCssClass` input.
      * The value should be the CSS class name that will be applied to the button group.
-     *```typescript
-     *public style1 = "styleClass";
-     * //..
-     *```
-     * ```html
-     *<igx-buttongroup [itemContentCssClass]="style1" [multiSelection]="!multi" [values]="alignOptions">
-     *```
+     * ```typescript
+     * public style1 = "styleClass";
+     *  //..
+     * ```
+     *  ```html
+     * <igx-buttongroup [itemContentCssClass]="style1" [multiSelection]="!multi" [values]="alignOptions">
+     * ```
      */
     @Input() set itemContentCssClass(value: string) {
         this._itemContentCssClass = value || this._itemContentCssClass;
     }
 
     /**
      * Returns the CSS class of the item content of the `IgxButtonGroup`.
-     *```typescript
-     *@ViewChild("MyChild")
-     *public buttonG: IgxButtonGroupComponent;
-     *ngAfterViewInit(){
-     *   let buttonSelect = this.buttonG.itemContentCssClass;
-     *}
-     *```
+     * ```typescript
+     *  @ViewChild("MyChild")
+     * public buttonG: IgxButtonGroupComponent;
+     * ngAfterViewInit(){
+     *    let buttonSelect = this.buttonG.itemContentCssClass;
+     * }
+     * ```
      */
     get itemContentCssClass(): string {
         return this._itemContentCssClass;
@@ -177,61 +177,61 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
      * Allows you to set the button group alignment.
      * Available options are `ButtonGroupAlignment.horizontal` (default) and `ButtonGroupAlignment.vertical`.
      * ```typescript
-     *public alignment = ButtonGroupAlignment.vertical;
+     * public alignment = ButtonGroupAlignment.vertical;
      * //..
      * ```
      * ```html
-     *<igx-buttongroup [multiSelection]="false" [values]="cities" [alignment]="alignment"></igx-buttongroup>
+     * <igx-buttongroup [multiSelection]="false" [values]="cities" [alignment]="alignment"></igx-buttongroup>
      * ```
      */
     @Input() set alignment(value: ButtonGroupAlignment) {
         this._isVertical = value === ButtonGroupAlignment.vertical;
     }
     /**
      * Returns the alignment of the `igx-buttongroup`.
-     *```typescript
-     *@ViewChild("MyChild")
-     *public buttonG: IgxButtonGroupComponent;
-     *ngAfterViewInit(){
+     * ```typescript
+     * @ViewChild("MyChild")
+     * public buttonG: IgxButtonGroupComponent;
+     * ngAfterViewInit(){
      *    let buttonAlignment = this.buttonG.alignment;
-     *}
-     *```
+     * }
+     * ```
      */
     get alignment(): ButtonGroupAlignment {
         return this._isVertical ? ButtonGroupAlignment.vertical : ButtonGroupAlignment.horizontal;
     }
 
     /**
      * An @Ouput property that emits an event when a button is selected.
-     *```typescript
-     *@ViewChild("toast")
-     *private toast: IgxToastComponent;
-     *public onSelect(buttongroup){
-     *    this.toast.show()
-     *}
-     * //...
-     *```
-     *```html
+     * ```typescript
+     * @ViewChild("toast")
+     * private toast: IgxToastComponent;
+     * public onSelect(buttongroup){
+     *     this.toast.show()
+     * }
+     *  //...
+     * ```
+     * ```html
      * <igx-buttongroup #MyChild [multiSelection]="!multi" (onSelect)="onSelect($event)"></igx-buttongroup>
-     *<igx-toast #toast message="You have made a selection!"></igx-toast>
-     *```
+     * <igx-toast #toast message="You have made a selection!"></igx-toast>
+     * ```
      */
     @Output() public onSelect = new EventEmitter<IButtonGroupEventArgs>();
 
     /**
      * An @Ouput property that emits an event when a button is deselected.
-     *```typescript
-     *@ViewChild("toast")
-     *private toast: IgxToastComponent;
-     *public onUnselect(buttongroup){
-     *    this.toast.show()
-     *}
-     * //...
-     *```
-     *```html
-     * igx-buttongroup #MyChild [multiSelection]="multi" (onUnselect)="onUnselect($event)"></igx-buttongroup>
-     *<igx-toast #toast message="You have deselected a button!"></igx-toast>
-     *```
+     * ```typescript
+     *  @ViewChild("toast")
+     *  private toast: IgxToastComponent;
+     *  public onUnselect(buttongroup){
+     *     this.toast.show()
+     * }
+     *  //...
+     * ```
+     * ```html
+     * <igx-buttongroup> #MyChild [multiSelection]="multi" (onUnselect)="onUnselect($event)"></igx-buttongroup>
+     * <igx-toast #toast message="You have deselected a button!"></igx-toast>
+     * ```
      */
     @Output() public onUnselect = new EventEmitter<IButtonGroupEventArgs>();
 
@@ -243,12 +243,12 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
      * ```
      * ```typescript
      * //...
-     *@ViewChild("MyChild")
-     *private buttonG: IgxButtonGroupComponent;
-     *ngAfterViewInit(){
+     * @ViewChild("MyChild")
+     * private buttonG: IgxButtonGroupComponent;
+     * ngAfterViewInit(){
      *    let orientation = this.buttonG.isVertical;
-     *}
-     *```
+     * }
+     * ```
      */
     public get isVertical(): boolean {
         return this._isVertical;
@@ -263,13 +263,13 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
 
     /**
      * Gets the selected button/buttons.
-     *```typescript
-     *@ViewChild("MyChild")
-     *private buttonG: IgxButtonGroupComponent;
-     *ngAfterViewInit(){
+     * ```typescript
+     * @ViewChild("MyChild")
+     * private buttonG: IgxButtonGroupComponent;
+     * ngAfterViewInit(){
      *    let selectedButton = this.buttonG.selectedButtons;
-     *}
-     *```
+     * }
+     * ```
      */
     get selectedButtons(): IgxButtonDirective[] {
         return this.buttons.filter((b, i) => {
@@ -280,14 +280,14 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
 
     /**
      * Selects a button by its index.
-     *```typescript
-     *@ViewChild("MyChild")
-     *private buttonG: IgxButtonGroupComponent;
-     *ngAfterViewInit(){
+     * ```typescript
+     * @ViewChild("MyChild")
+     * private buttonG: IgxButtonGroupComponent;
+     * ngAfterViewInit(){
      *    this.buttonG.selectButton(2);
      *    this.cdr.detectChanges();
-     *}
-     *```
+     * }
+     * ```
      * @memberOf {@link IgxButtonGroupComponent}
      */
     public selectButton(index: number) {
@@ -324,12 +324,12 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
     /**
      * Deselects a button by its index.
      * ```typescript
-     *@ViewChild("MyChild")
-     *private buttonG: IgxButtonGroupComponent;
-     *ngAfterViewInit(){
+     * @ViewChild("MyChild")
+     * private buttonG: IgxButtonGroupComponent;
+     * ngAfterViewInit(){
      *    this.buttonG.deselectButton(2);
      *    this.cdr.detectChanges();
-     *}
+     * }
      * ```
      * @memberOf {@link IgxButtonGroupComponent}
      */
@@ -412,7 +412,7 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
     }
 
     /**
-     *@hidden
+     * @hidden
      */
     public _clickHandler(event, i) {
         if (this.selectedIndexes.indexOf(i) !== -1) {