Skip to content

Commit 99f3f02

Browse files
authored
Merge pull request #5877 from IgniteUI/validate-comments-8.1.x
docs(*): validating some comments for typedoc export
2 parents 56c2ca9 + a521fbf commit 99f3f02

File tree

4 files changed

+14
-11
lines changed

4 files changed

+14
-11
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,6 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
279279

280280
/**
281281
* Selects a button by its index.
282-
* @memberOf {@link IgxButtonGroupComponent}
283282
*```typescript
284283
*@ViewChild("MyChild")
285284
*private buttonG: IgxButtonGroupComponent;
@@ -288,6 +287,7 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
288287
* this.cdr.detectChanges();
289288
*}
290289
*```
290+
* @memberOf {@link IgxButtonGroupComponent}
291291
*/
292292
public selectButton(index: number) {
293293
if (index >= this.buttons.length || index < 0) {
@@ -326,7 +326,6 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
326326

327327
/**
328328
* Deselects a button by its index.
329-
* @memberOf {@link IgxButtonGroupComponent}
330329
* ```typescript
331330
*@ViewChild("MyChild")
332331
*private buttonG: IgxButtonGroupComponent;
@@ -335,6 +334,7 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
335334
* this.cdr.detectChanges();
336335
*}
337336
* ```
337+
* @memberOf {@link IgxButtonGroupComponent}
338338
*/
339339
public deselectButton(index: number) {
340340
if (index >= this.buttons.length || index < 0) {

projects/igniteui-angular/src/lib/grids/column.component.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -616,7 +616,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy {
616616
/**
617617
* Gets the column `sortStrategy`.
618618
* ```typescript
619-
* let sortStrategy = this.column.sortStrategy'
619+
* let sortStrategy = this.column.sortStrategy
620620
* ```
621621
* @memberof IgxColumnComponent
622622
*/
@@ -628,10 +628,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy {
628628
* Sets the column `sortStrategy`.
629629
* ```typescript
630630
* this.column.sortStrategy = new CustomSortingStrategy().
631-
*
632-
* class CustomSortingStrategy extends SortingStrategy {
633-
* ...
634-
* }
631+
* class CustomSortingStrategy extends SortingStrategy {...}
635632
* ```
636633
* @memberof IgxColumnComponent
637634
*/
@@ -1557,7 +1554,6 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy {
15571554
* Autosize the column to the longest currently visible cell value, including the header cell.
15581555
* ```typescript
15591556
* @ViewChild('grid') grid: IgxGridComponent;
1560-
*
15611557
* let column = this.grid.columnList.filter(c => c.field === 'ID')[0];
15621558
* column.autosize();
15631559
* ```

projects/igniteui-angular/src/lib/grids/grid-base.component.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,14 @@ export abstract class IgxGridBaseComponent extends DisplayDensityBase implements
445445

446446
/**
447447
* Sets the current page index.
448+
* ```html
448449
* <igx-grid #grid [data]="Data" [paging]="true" [page]="5" [autoGenerate]="true"></igx-grid>
450+
*```
451+
* Two-way data binding.
452+
* ```html
453+
* <igx-grid #grid [data]="Data" [paging]="true" [(page)]="model.page" [autoGenerate]="true"></igx-grid>
454+
* ```
455+
* @memberof IgxGridBaseComponent
449456
*/
450457
set page(val: number) {
451458
if (val === this._page || val < 0 || val > this.totalPages - 1) {
@@ -2017,7 +2024,8 @@ export abstract class IgxGridBaseComponent extends DisplayDensityBase implements
20172024
* for the built-in column hiding UI of the`IgxColumnComponent`.
20182025
* ```typescript
20192026
* const hiddenColText = this.grid.hiddenColumnsText;
2020-
* ``
2027+
* ```
2028+
* @memberof IgxGridBaseComponent
20212029
*/
20222030
@WatchChanges()
20232031
@Input()
@@ -3845,7 +3853,7 @@ export abstract class IgxGridBaseComponent extends DisplayDensityBase implements
38453853
* Returns how many times the grid contains the string.
38463854
* ```typescript
38473855
* this.grid.findPrev("financial");
3848-
* ````
3856+
* ```
38493857
* @param text the string to search.
38503858
* @param caseSensitive optionally, if the search should be case sensitive (defaults to false).
38513859
* @param exactMatch optionally, if the text should match the entire value (defaults to false).

projects/igniteui-angular/src/lib/grids/grid/grid.component.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,6 @@ export class IgxGridComponent extends IgxGridBaseComponent implements IGridDataB
425425
* <igx-grid [dropAreaTemplate]="dropAreaRef">
426426
* <igx-column [groupable]="true" field="ID"></igx-column>
427427
* </igx-grid>
428-
*
429428
* <ng-template #myDropArea>
430429
* <span> Custom drop area! </span>
431430
* </ng-template>

0 commit comments

Comments
 (0)