Merge pull request #10554 from IgniteUI/pbozhinov/adds-some-comments-to-some-pivot-interfaces

Adds some comments to exposed pivot configs

Author: dkamburov

projects/igniteui-angular/src/lib/grids/pivot-grid/pivot-grid.interface.ts

@@ -14,35 +14,47 @@ export interface IPivotDimensionStrategy {
 export type PivotAggregation = (members: any[], data: any[]) => any;
 
 export interface IPivotAggregator {
-    // Aggregation unique key.
+    /** Aggregation unique key. */
     key: string;
-    // Aggregation label to show in the UI.
+    /** Aggregation label to show in the UI. */
     label: string;
-    // Aggregator function can be a custom implementation of PivotAggregation or
-    // use predefined ones from IgxPivotAggregate and its variants.
+    /**
+     * Aggregator function can be a custom implementation of `PivotAggregation`, or 
+     * use predefined ones from `IgxPivotAggregate` and its variants.
+     */
     aggregator: (members: any[], data?: any[]) => any;
 }
 
+/**
+ * Configuration of the pivot grid.
+ */
 export interface IPivotConfiguration {
+    /** A strategy to transform the rows. */
     rowStrategy?: IPivotDimensionStrategy | null;
+    /** A strategy to transform the columns. */
     columnStrategy?: IPivotDimensionStrategy | null;
+    /** A list of the rows. */
     rows: IPivotDimension[] | null;
+    /** A list of the columns. */
     columns: IPivotDimension[] | null;
+    /** A list of the values. */
     values: IPivotValue[] | null;
-    // dimensions to be displayed in the filter area.
+    /** Dimensions to be displayed in the filter area. */
     filters?: IPivotDimension[] | null;
 }
 
 export interface IPivotDimension {
-    // allow defining a hierarchy when multiple sub groups need to be extracted from single member.
+    /** Allows defining a hierarchy when multiple sub groups need to be extracted from single member. */
     childLevel?: IPivotDimension;
-    // field name which to use to extract value
+    /** Field name to use in order to extract value. */
     memberName: string;
-    // function that extract the value
+    /** Function that extracts the value */
     memberFunction?: (data: any) => any;
-    // Enables/Disables a particular dimension from pivot structure.
+    /** Enables/Disables a particular dimension from pivot structure. */
     enabled: boolean;
-    // A predefined or defined via the `igxPivotSelector` filter expression tree for the current dimension to be applied in the filter pipe.
+    /**
+     * A predefined or defined via the `igxPivotSelector` filter expression tree for the current dimension to be applied in the filter pipe.
+     * */
     filter?: FilteringExpressionsTree | null;
     sortDirection?: SortingDirection;
     dataType?: GridColumnDataType;