From c93a923585eabdbd1922cfa90d954284df6e4064 Mon Sep 17 00:00:00 2001 From: Aleksandar Kamenov Date: Fri, 27 Sep 2019 17:23:08 +0300 Subject: [PATCH] docs(*): validating some comments for typedoc export Closes #3183 --- .../src/lib/buttonGroup/buttonGroup.component.ts | 4 ++-- .../src/lib/grids/column.component.ts | 8 ++------ .../src/lib/grids/grid-base.component.ts | 11 ++++++++--- .../src/lib/grids/grid/grid.component.ts | 1 - 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/projects/igniteui-angular/src/lib/buttonGroup/buttonGroup.component.ts b/projects/igniteui-angular/src/lib/buttonGroup/buttonGroup.component.ts index f14c0d0aa07..373f3fb1073 100644 --- a/projects/igniteui-angular/src/lib/buttonGroup/buttonGroup.component.ts +++ b/projects/igniteui-angular/src/lib/buttonGroup/buttonGroup.component.ts @@ -280,7 +280,6 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After /** * Selects a button by its index. - * @memberOf {@link IgxButtonGroupComponent} *```typescript *@ViewChild("MyChild") *private buttonG: IgxButtonGroupComponent; @@ -289,6 +288,7 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After * this.cdr.detectChanges(); *} *``` + * @memberOf {@link IgxButtonGroupComponent} */ public selectButton(index: number) { if (index >= this.buttons.length || index < 0) { @@ -327,7 +327,6 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After /** * Deselects a button by its index. - * @memberOf {@link IgxButtonGroupComponent} * ```typescript *@ViewChild("MyChild") *private buttonG: IgxButtonGroupComponent; @@ -336,6 +335,7 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After * this.cdr.detectChanges(); *} * ``` + * @memberOf {@link IgxButtonGroupComponent} */ public deselectButton(index: number) { if (index >= this.buttons.length || index < 0) { diff --git a/projects/igniteui-angular/src/lib/grids/column.component.ts b/projects/igniteui-angular/src/lib/grids/column.component.ts index 3c5a6da2048..3a2a2620b45 100644 --- a/projects/igniteui-angular/src/lib/grids/column.component.ts +++ b/projects/igniteui-angular/src/lib/grids/column.component.ts @@ -612,7 +612,7 @@ export class IgxColumnComponent implements AfterContentInit { /** * Gets the column `sortStrategy`. * ```typescript - * let sortStrategy = this.column.sortStrategy' + * let sortStrategy = this.column.sortStrategy * ``` * @memberof IgxColumnComponent */ @@ -624,10 +624,7 @@ export class IgxColumnComponent implements AfterContentInit { * Sets the column `sortStrategy`. * ```typescript * this.column.sortStrategy = new CustomSortingStrategy(). - * - * class CustomSortingStrategy extends SortingStrategy { - * ... - * } + * class CustomSortingStrategy extends SortingStrategy {...} * ``` * @memberof IgxColumnComponent */ @@ -1536,7 +1533,6 @@ export class IgxColumnComponent implements AfterContentInit { * Autosize the column to the longest currently visible cell value, including the header cell. * ```typescript * @ViewChild('grid') grid: IgxGridComponent; - * * let column = this.grid.columnList.filter(c => c.field === 'ID')[0]; * column.autosize(); * ``` diff --git a/projects/igniteui-angular/src/lib/grids/grid-base.component.ts b/projects/igniteui-angular/src/lib/grids/grid-base.component.ts index fbde7c630d6..b735ffe9788 100644 --- a/projects/igniteui-angular/src/lib/grids/grid-base.component.ts +++ b/projects/igniteui-angular/src/lib/grids/grid-base.component.ts @@ -525,10 +525,14 @@ export abstract class IgxGridBaseComponent extends DisplayDensityBase implements /** * Sets the current page index. + * ```html * - * + *``` * Two-way data binding. + * ```html * + * ``` + * @memberof IgxGridBaseComponent */ set page(val: number) { if (val === this._page || val < 0 || val > this.totalPages - 1) { @@ -2252,7 +2256,8 @@ export abstract class IgxGridBaseComponent extends DisplayDensityBase implements * for the built-in column hiding UI of the`IgxColumnComponent`. * ```typescript * const hiddenColText = this.grid.hiddenColumnsText; - * `` + * ``` + * @memberof IgxGridBaseComponent */ @WatchChanges() @Input() @@ -4138,7 +4143,7 @@ export abstract class IgxGridBaseComponent extends DisplayDensityBase implements * Returns how many times the grid contains the string. * ```typescript * this.grid.findPrev("financial"); - * ```` + * ``` * @param text the string to search. * @param caseSensitive optionally, if the search should be case sensitive (defaults to false). * @param exactMatch optionally, if the text should match the entire value (defaults to false). diff --git a/projects/igniteui-angular/src/lib/grids/grid/grid.component.ts b/projects/igniteui-angular/src/lib/grids/grid/grid.component.ts index aadf5156c0e..09a3d625277 100644 --- a/projects/igniteui-angular/src/lib/grids/grid/grid.component.ts +++ b/projects/igniteui-angular/src/lib/grids/grid/grid.component.ts @@ -422,7 +422,6 @@ export class IgxGridComponent extends IgxGridBaseComponent implements IGridDataB * * * - * * * Custom drop area! *