chore(*): Additional minor changes.

Author: MKirova

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

@@ -575,7 +575,6 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
     * ```html
     * <igx-grid #grid [showToolbar]="true" [rowEditable]="true" [primaryKey]="'ProductID'" [columnHiding]="true"></igx-grid>
     * ```
-     * @memberof IgxGridBaseDirective
     */
     @WatchChanges()
     @Input()
@@ -643,6 +642,7 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
 
     /**
      * Gets the width of the header.
+     * @example
      * ```html
      * let gridHeaderWidth = this.grid.headerWidth;
      * ```
@@ -1049,7 +1049,6 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
      * <igx-grid #grid3 (onCellEditCancel)="editCancel($event)" [data]="data" [primaryKey]="'ProductID'">
      * </igx-grid>
      * ```
-	 * @memberof IgxGridComponent
      */
     @Output()
     public onCellEditCancel = new EventEmitter<IGridEditEventArgs>();
@@ -1063,7 +1062,6 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
      * <igx-grid #grid3 (onCellEditEnter)="editStart($event)" [data]="data" [primaryKey]="'ProductID'">
      * </igx-grid>
      * ```
-	 * @memberof IgxGridComponent
      */
     @Output()
     public onCellEditEnter = new EventEmitter<IGridEditEventArgs>();
@@ -1092,7 +1090,6 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
      * <igx-grid #grid3 (onRowEditEnter)="editStart($event)" [primaryKey]="'ProductID'" [rowEditable]="true">
      * </igx-grid>
      * ```
-	 * @memberof IgxGridComponent
      */
     @Output()
     public onRowEditEnter = new EventEmitter<IGridEditEventArgs>();
@@ -2955,7 +2952,6 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
      * <igx-grid #grid [data]="data" [(expansionStates)]="model.expansionStates">
      * </igx-grid>
      * ```
-	 * @memberof IgxGridComponent
      */
     @Input()
     public get expansionStates() {
@@ -2976,7 +2972,6 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
      * ```typescript
      * this.grid.expandAll();
      * ```
-	 * @memberof IgxGridBaseDirective
     */
     public expandAll() {
         this._defaultExpandState = true;
@@ -2989,7 +2984,6 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
      * ```typescript
      * this.grid.collapseAll();
      * ```
-	 * @memberof IgxGridBaseDirective
     */
     public collapseAll() {
         this._defaultExpandState = false;
@@ -3004,6 +2998,7 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
      * ```typescript
      * this.grid.expandRow(rowID);
      * ```
+     * @param rowID The row id - primaryKey value or the data record instance.
      */
     public expandRow(rowID: any) {
         this.gridAPI.set_row_expansion_state(rowID, true);
@@ -3017,7 +3012,7 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
      * ```typescript
      * this.grid.collapseRow(rowID);
      * ```
-	 * @memberof IgxGridBaseDirective
+     * @param rowID The row id - primaryKey value or the data record instance.
     */
     public collapseRow(rowID: any) {
         this.gridAPI.set_row_expansion_state(rowID, false);
@@ -3032,14 +3027,18 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
      * ```typescript
      * this.grid.toggleRow(rowID);
      * ```
-	 * @memberof IgxGridBaseDirective
+     * @param rowID The row id - primaryKey value or the data record instance.
     */
     public toggleRow(rowID: any) {
         const rec = this.gridAPI.get_rec_by_id(rowID);
         const state = this.gridAPI.get_row_expansion_state(rec);
         this.gridAPI.set_row_expansion_state(rowID, !state);
     }
 
+    /**
+     * @hidden
+     * @internal
+    */
     public getDefaultExpandState(rec: any) {
         return this._defaultExpandState;
     }
@@ -3528,7 +3527,6 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
      * ```typescript
      * grid.moveColumn(compName, persDetails);
      * ```
-	  * @memberof IgxGridBaseDirective
 	  */
     public moveColumn(column: IgxColumnComponent, dropTarget: IgxColumnComponent, pos: DropPosition = DropPosition.None) {
 
@@ -4837,7 +4835,6 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
      * ```typescript
      *      const dataView = this.grid.dataView;
      * ```
-     * @memberof IgxGridComponent
      */
     get dataView(): any[] {
         return this.verticalScrollContainer.igxForOf;
@@ -5186,7 +5183,6 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
     * ```typescript
     *  const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);
     * ```
-    * @memberof IgxGridBaseDirective
     */
     public getNextCell(currRowIndex: number, curVisibleColIndex: number,
         callback: (IgxColumnComponent) => boolean = null): ICellPosition {
@@ -5220,7 +5216,6 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
     * ```typescript
     *  const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);
     * ```
-    * @memberof IgxGridBaseDirective
     */
     public getPreviousCell(currRowIndex: number, curVisibleColIndex: number,
         callback: (IgxColumnComponent) => boolean = null): ICellPosition {

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

@@ -314,6 +314,7 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
 
     /**
      * Gets the hierarchical representation of the group by records.
+     * @example
      * ```typescript
      * let groupRecords = this.grid.groupsRecords;
      * ```
@@ -631,6 +632,7 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
 
     /**
      * Gets/Sets the template reference of the `IgxGridComponent`'s group area.
+     * @example
      * ```typescript
      * const groupAreaTemplate = this.grid.groupAreaTemplate;
      * this.grid.groupAreaTemplate = myAreaTemplate.
@@ -647,8 +649,10 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
 
     /**
      * Groups by a new `IgxColumnComponent` based on the provided expression, or modifies an existing one.
+     * @remarks
      * Also allows for multiple columns to be grouped at once if an array of `ISortingExpression` is passed.
      * The onGroupingDone event would get raised only **once** if this method gets called multiple times with the same arguments.
+     * @example
      * ```typescript
      * this.grid.groupBy({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });
      * this.grid.groupBy([
@@ -672,14 +676,17 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
     }
 
     /**
+     * Clears grouping for particular column, array of columns or all columns.
+     * @remarks
      * Clears all grouping in the grid, if no parameter is passed.
      * If a parameter is provided, clears grouping for a particular column or an array of columns.
+     * @example
      * ```typescript
      * this.grid.clearGrouping(); //clears all grouping
      * this.grid.clearGrouping("ID"); //ungroups a single column
      * this.grid.clearGrouping(["ID", "Column1", "Column2"]); //ungroups multiple columns
      * ```
-     *
+     *@param name Name of column or array of column names to be ungrouped.
      */
     public clearGrouping(name?: string | Array<string>): void {
         this._gridAPI.clear_groupby(name);
@@ -688,6 +695,8 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
 
     /**
      * Returns if a group is expanded or not.
+     * @param group The group record.
+     * @example
      * ```typescript
      * public groupRow: IGroupByRecord;
      * const expandedGroup = this.grid.isExpandedGroup(this.groupRow);
@@ -700,6 +709,8 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
 
     /**
      * Toggles the expansion state of a group.
+     * @param groupRow The group record to toggle.
+     * @example
      * ```typescript
      * public groupRow: IGroupByRecord;
      * const toggleExpGroup = this.grid.toggleGroup(this.groupRow);
@@ -712,6 +723,8 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
 
     /**
      * Expands the specified group and all of its parent groups.
+     * @param groupRow The group record to fully expand.
+     * @example
      * ```typescript
      * public groupRow: IGroupByRecord;
      * this.grid.fullyExpandGroup(this.groupRow);
@@ -732,6 +745,7 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
 
     /**
      * Toggles the expansion state of all group rows recursively.
+     * @example
      * ```typescript
      * this.grid.toggleAllGroupRows;
      * ```
@@ -744,6 +758,7 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
 
     /**
      * Returns if the `IgxGridComponent` has groupable columns.
+     * @example
      * ```typescript
      * const groupableGrid = this.grid.hasGroupableColumns;
      * ```
@@ -762,7 +777,8 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
     }
 
     /**
-     * Returns if the grid's group by drop area is visible.
+     * Gets if the grid's group by drop area is visible.
+     * @example
      * ```typescript
      * const dropVisible = this.grid.dropAreaVisible;
      * ```