Skip to content

Commit 5bb569e

Browse files
authored
Merge pull request #5876 from IgniteUI/validate-comments
docs(*): validating some comments for typedoc export
2 parents da557ed + 6188c49 commit 5bb569e

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
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
@@ -280,7 +280,6 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
280280

281281
/**
282282
* Selects a button by its index.
283-
* @memberOf {@link IgxButtonGroupComponent}
284283
*```typescript
285284
*@ViewChild("MyChild")
286285
*private buttonG: IgxButtonGroupComponent;
@@ -289,6 +288,7 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
289288
* this.cdr.detectChanges();
290289
*}
291290
*```
291+
* @memberOf {@link IgxButtonGroupComponent}
292292
*/
293293
public selectButton(index: number) {
294294
if (index >= this.buttons.length || index < 0) {
@@ -327,7 +327,6 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
327327

328328
/**
329329
* Deselects a button by its index.
330-
* @memberOf {@link IgxButtonGroupComponent}
331330
* ```typescript
332331
*@ViewChild("MyChild")
333332
*private buttonG: IgxButtonGroupComponent;
@@ -336,6 +335,7 @@ export class IgxButtonGroupComponent extends DisplayDensityBase implements After
336335
* this.cdr.detectChanges();
337336
*}
338337
* ```
338+
* @memberOf {@link IgxButtonGroupComponent}
339339
*/
340340
public deselectButton(index: number) {
341341
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
@@ -615,7 +615,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy {
615615
/**
616616
* Gets the column `sortStrategy`.
617617
* ```typescript
618-
* let sortStrategy = this.column.sortStrategy'
618+
* let sortStrategy = this.column.sortStrategy
619619
* ```
620620
* @memberof IgxColumnComponent
621621
*/
@@ -627,10 +627,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy {
627627
* Sets the column `sortStrategy`.
628628
* ```typescript
629629
* this.column.sortStrategy = new CustomSortingStrategy().
630-
*
631-
* class CustomSortingStrategy extends SortingStrategy {
632-
* ...
633-
* }
630+
* class CustomSortingStrategy extends SortingStrategy {...}
634631
* ```
635632
* @memberof IgxColumnComponent
636633
*/
@@ -1544,7 +1541,6 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy {
15441541
* Autosize the column to the longest currently visible cell value, including the header cell.
15451542
* ```typescript
15461543
* @ViewChild('grid') grid: IgxGridComponent;
1547-
*
15481544
* let column = this.grid.columnList.filter(c => c.field === 'ID')[0];
15491545
* column.autosize();
15501546
* ```

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

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -525,10 +525,14 @@ export abstract class IgxGridBaseComponent extends DisplayDensityBase implements
525525

526526
/**
527527
* Sets the current page index.
528+
* ```html
528529
* <igx-grid #grid [data]="Data" [paging]="true" [page]="5" [autoGenerate]="true"></igx-grid>
529-
*
530+
*```
530531
* Two-way data binding.
532+
* ```html
531533
* <igx-grid #grid [data]="Data" [paging]="true" [(page)]="model.page" [autoGenerate]="true"></igx-grid>
534+
* ```
535+
* @memberof IgxGridBaseComponent
532536
*/
533537
set page(val: number) {
534538
if (val === this._page || val < 0 || val > this.totalPages - 1) {
@@ -2252,7 +2256,8 @@ export abstract class IgxGridBaseComponent extends DisplayDensityBase implements
22522256
* for the built-in column hiding UI of the`IgxColumnComponent`.
22532257
* ```typescript
22542258
* const hiddenColText = this.grid.hiddenColumnsText;
2255-
* ``
2259+
* ```
2260+
* @memberof IgxGridBaseComponent
22562261
*/
22572262
@WatchChanges()
22582263
@Input()
@@ -4138,7 +4143,7 @@ export abstract class IgxGridBaseComponent extends DisplayDensityBase implements
41384143
* Returns how many times the grid contains the string.
41394144
* ```typescript
41404145
* this.grid.findPrev("financial");
4141-
* ````
4146+
* ```
41424147
* @param text the string to search.
41434148
* @param caseSensitive optionally, if the search should be case sensitive (defaults to false).
41444149
* @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
@@ -422,7 +422,6 @@ export class IgxGridComponent extends IgxGridBaseComponent implements IGridDataB
422422
* <igx-grid [dropAreaTemplate]="dropAreaRef">
423423
* <igx-column [groupable]="true" field="ID"></igx-column>
424424
* </igx-grid>
425-
*
426425
* <ng-template #myDropArea>
427426
* <span> Custom drop area! </span>
428427
* </ng-template>

0 commit comments

Comments
 (0)