Merge pull request #2902 from IgniteUI/typedoc-hide-definitions

chore(typedoc): hide some declarations from typedoc document

Author: bazal4o

projects/igniteui-angular/src/lib/calendar/calendar.directives.ts

@@ -212,6 +212,9 @@ export class IgxCalendarDateDirective {
     }
 }
 
+/**
+ * @hidden
+ */
 @Directive({
     selector: '[igxCalendarHeader]'
 })
@@ -220,6 +223,9 @@ export class IgxCalendarHeaderTemplateDirective {
     constructor(public template: TemplateRef<any>) {}
 }
 
+/**
+ * @hidden
+ */
 @Directive({
     selector: '[igxCalendarSubheader]'
 })

projects/igniteui-angular/src/lib/chips/chips.module.ts

@@ -10,6 +10,9 @@ import { IgxDragDropModule } from '../directives/dragdrop/dragdrop.directive';
 import { IgxPrefixModule, IgxPrefixDirective} from '../directives/prefix/prefix.directive';
 import { IgxSuffixModule, IgxSuffixDirective } from '../directives/suffix/suffix.directive';
 
+/**
+ * @hidden
+ */
 @NgModule({
   declarations: [
     IgxChipsAreaComponent,

projects/igniteui-angular/src/lib/combo/combo-dropdown.component.ts

@@ -12,6 +12,7 @@ import { IgxForOfDirective } from '../directives/for-of/for_of.directive';
 import { Subject } from 'rxjs';
 import { CancelableEventArgs } from '../core/utils';
 
+/** @hidden */
 @Component({
     selector: 'igx-combo-drop-down',
     templateUrl: '../drop-down/drop-down.component.html'

projects/igniteui-angular/src/lib/combo/combo-item.component.ts

@@ -11,6 +11,7 @@ import { IgxSelectionAPIService } from '../core/selection';
 import { IgxDropDownItemBase } from '../drop-down/drop-down-item.component';
 import { IgxComboDropDownComponent } from './combo-dropdown.component';
 
+/** @hidden */
 @Component({
     selector: 'igx-combo-item',
     templateUrl: 'combo-item.component.html'

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

@@ -1491,6 +1491,9 @@ export class IgxComboComponent implements AfterViewInit, ControlValueAccessor, O
     }
 }
 
+/**
+ * @hidden
+ */
 @NgModule({
     declarations: [IgxComboComponent, IgxComboItemComponent, IgxComboFilterConditionPipe, IgxComboGroupingPipe,
         IgxComboFilteringPipe, IgxComboSortingPipe, IgxComboDropDownComponent,

projects/igniteui-angular/src/lib/combo/combo.directives.ts

@@ -1,31 +1,54 @@
 import { Directive } from '@angular/core';
 
+/**
+ * @hidden
+ */
 @Directive({
     selector: '[igxComboHeader]'
 })
 export class IgxComboHeaderDirective {
 }
+
+/**
+ * @hidden
+ */
 @Directive({
     selector: '[igxComboFooter]'
 })
 export class IgxComboFooterDirective {
 }
+
+/**
+ * @hidden
+ */
 @Directive({
     selector: '[igxComboItem]'
 })
 export class IgxComboItemDirective {
 }
+
+/**
+ * @hidden
+ */
 @Directive({
     selector: '[igxComboEmpty]'
 })
 export class IgxComboEmptyDirective {
 }
+
+/**
+ * @hidden
+ */
 @Directive({
     selector: '[igxComboHeaderItem]'
 })
 
 export class IgxComboHeaderItemDirective {
 }
+
+/**
+ * @hidden
+ */
 @Directive({
     selector: '[igxComboAddItem]'
 })

projects/igniteui-angular/src/lib/combo/combo.pipes.ts

@@ -38,6 +38,7 @@ export class IgxComboFilteringPipe implements PipeTransform {
     }
 }
 
+/** @hidden */
 export class SimpleFilteringStrategy extends FilteringStrategy {
     public findMatchByExpression(rec: object, expr: IFilteringExpression): boolean {
         const cond = expr.condition;

projects/igniteui-angular/src/lib/core/base.ts

@@ -1,15 +1,25 @@
+
+/**
+ * @hidden
+ */
 export function DeprecateClass(message: string): ClassDecorator {
     return (constructor: any) => {
         console.warn(constructor.name + ': ' + message);
     };
 }
 
+/**
+ * @hidden
+ */
 export function DeprecateMethod(message: string): MethodDecorator {
     return (constructor: any) => {
         console.warn(constructor.constructor.name + ': ' + message);
     };
 }
 
+/**
+ * @hidden
+ */
 export function DeprecateProperty(message: string): PropertyDecorator {
     return (constructor: any) => {
         console.warn(constructor.constructor.name + ': ' + message);

projects/igniteui-angular/src/lib/core/deprecateDecorators.ts

@@ -1,5 +1,6 @@
 import { Injectable } from '@angular/core';
 
+/** @hidden */
 @Injectable({
     providedIn: 'root',
 })

projects/igniteui-angular/src/lib/core/selection.ts

@@ -6,6 +6,7 @@ const EVENT_SUFFIX = 'precise';
 /**
  * Touch gestures manager based on Hammer.js
  * Use with caution, this will track references for single manager per element. Very TBD. Much TODO.
+ * @hidden
  */
 @Injectable()
 export class HammerGesturesManager {

projects/igniteui-angular/src/lib/core/touch.ts

@@ -110,11 +110,12 @@ export function isDate(value: any) {
 }
 
 /**
- * Cehcks if the two passed arguments are equal
+ * Checks if the two passed arguments are equal
  * Currently supports date objects
  * @param obj1
  * @param obj2
  * @returns: `boolean`
+ * @hidden
  */
 export function isEqual(obj1, obj2): boolean {
     if (isDate(obj1) && isDate(obj2)) {
@@ -223,6 +224,7 @@ export function isFirefox(): boolean {
     return firefoxBrowser;
 }
 
+/** @hidden */
 export function isNavigationKey(key: string): boolean {
     return ['down', 'up', 'left', 'right', 'arrowdown', 'arrowup', 'arrowleft', 'arrowright',
         'home', 'end', 'space', 'spacebar', ' '].indexOf(key) !== -1;

projects/igniteui-angular/src/lib/core/utils.ts

@@ -9,10 +9,17 @@ import { ISortingExpression, SortingDirection } from './sorting-expression.inter
 import { ISortingState } from './sorting-state.interface';
 import { ISortingStrategy, SortingStrategy } from './sorting-strategy';
 
+/**
+ * @hidden
+ */
 export enum DataAccess {
     OriginalData,
     TransformedData
 }
+
+/**
+ * @hidden
+ */
 export class DataContainer {
     public data: any[];
     /**

projects/igniteui-angular/src/lib/data-operations/data-container.ts

@@ -2,6 +2,9 @@ import { IFilteringState } from './filtering-state.interface';
 import { IPagingState } from './paging-state.interface';
 import { ISortingState } from './sorting-state.interface';
 
+/**
+ * @hidden
+ */
 export interface IDataState {
     filtering?: IFilteringState;
     sorting?: ISortingState;

projects/igniteui-angular/src/lib/data-operations/data-state.interface.ts

@@ -10,13 +10,19 @@ import { Transaction, TransactionType, HierarchicalTransaction, IgxHierarchicalT
 import { mergeObjects, cloneValue } from '../core/utils';
 import { ITreeGridRecord } from '../grids/tree-grid/tree-grid.interfaces';
 
+/**
+ * @hidden
+ */
 export enum DataType {
     String = 'string',
     Number = 'number',
     Boolean = 'boolean',
     Date = 'date'
 }
 
+/**
+ * @hidden
+ */
 export class DataUtil {
     public static mergeDefaultProperties(target: object, defaults: object) {
         if (!defaults) {

projects/igniteui-angular/src/lib/data-operations/data-util.ts

@@ -1,3 +1,7 @@
+
+/**
+ * @hidden
+ */
 export interface IRecordInfo {
     index: number;
     record: object;

projects/igniteui-angular/src/lib/data-operations/record-info.interface.ts

@@ -1,5 +1,8 @@
 import { SortingStrategy } from './sorting-strategy';
 
+/**
+ * @hidden
+ */
 export class StableSortingStrategy extends SortingStrategy {
     protected compareObjects(obj1: any, obj2: any): number {
         const res = super.compareObjects.apply(this, arguments);

projects/igniteui-angular/src/lib/data-operations/stable-sorting-strategy.ts

@@ -1,13 +1,26 @@
 import {DataType} from '../data-util';
 
+/**
+ * @hidden
+ */
 const COUNT_ROWS = 5;
+
+/**
+ * @hidden
+ */
 const COUNT_COLS = 4;
 
+/**
+ * @hidden
+ */
 export interface IDataColumn {
     fieldName: string;
     type: DataType;
 }
 
+/**
+ * @hidden
+ */
 export class DataGenerator {
     public columns: IDataColumn[] = [];
     public data: object[] = [];

projects/igniteui-angular/src/lib/data-operations/test-util/data-generator.ts

@@ -1,6 +1,9 @@
 import { DOCUMENT } from '@angular/common';
 import { Directive, HostBinding } from '@angular/core';
 
+/**
+ * @hidden
+ */
 @Directive({
     selector: 'igx-dialog-title,[igxDialogTitle]'
 })
@@ -10,6 +13,9 @@ export class IgxDialogTitleDirective {
     public defaultStyle = true;
  }
 
+/**
+ * @hidden
+ */
 @Directive({
     selector: 'igx-dialog-actions,[igxDialogActions]'
 })

projects/igniteui-angular/src/lib/dialog/dialog.directives.ts

@@ -1,5 +1,8 @@
 import { Component, ElementRef, HostBinding, Input, ViewChild, ViewContainerRef } from '@angular/core';
 
+/**
+ * @hidden
+ */
 @Component({
     selector: 'igx-horizontal-virtual-helper',
     template: '<div #horizontal_container class="igx-vhelper__placeholder-content" [style.width.px]="width"></div>'

projects/igniteui-angular/src/lib/directives/for-of/horizontal.virtual.helper.component.ts

@@ -1,5 +1,9 @@
 import { Directive, HostBinding } from '@angular/core';
 
+
+/**
+ * @hidden
+ */
 @Directive({
     selector: '[igxLabel]'
 })

projects/igniteui-angular/src/lib/directives/label/label.directive.ts

@@ -1,4 +1,11 @@
+/**
+ * @hidden
+ */
 export const MASK_FLAGS = [ 'C', '&', 'a', 'A', '?', 'L', '9', '0', '#' ];
+
+/**
+ * @hidden
+ */
 export const KEYS = {
     Ctrl : 17,
     Z : 90,
@@ -8,6 +15,10 @@ export const KEYS = {
     DELETE : 46
   };
 
+
+/**
+ * @hidden
+ */
 export class MaskHelper {
     private _cursor;
     public get cursor() {

projects/igniteui-angular/src/lib/directives/mask/mask-helper.ts

@@ -1,10 +1,16 @@
 import { NgModule, Directive } from '@angular/core';
 
+/**
+ * @hidden
+ */
 @Directive({
     selector: 'igx-prefix,[igxPrefix]'
 })
 export class IgxPrefixDirective { }
 
+/**
+ * @hidden
+ */
 @NgModule({
     declarations: [IgxPrefixDirective],
     exports: [IgxPrefixDirective]