Skip to content

chore(typedoc): hide some declarations from typedoc document #2902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Nov 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,9 @@ export class IgxCalendarDateDirective {
}
}

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

/**
* @hidden
*/
@Directive({
selector: '[igxCalendarSubheader]'
})
Expand Down
3 changes: 3 additions & 0 deletions projects/igniteui-angular/src/lib/chips/chips.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
3 changes: 3 additions & 0 deletions projects/igniteui-angular/src/lib/combo/combo.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1491,6 +1491,9 @@ export class IgxComboComponent implements AfterViewInit, ControlValueAccessor, O
}
}

/**
* @hidden
*/
@NgModule({
declarations: [IgxComboComponent, IgxComboItemComponent, IgxComboFilterConditionPipe, IgxComboGroupingPipe,
IgxComboFilteringPipe, IgxComboSortingPipe, IgxComboDropDownComponent,
Expand Down
23 changes: 23 additions & 0 deletions projects/igniteui-angular/src/lib/combo/combo.directives.ts
Original file line number Diff line number Diff line change
@@ -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]'
})
Expand Down
1 change: 1 addition & 0 deletions projects/igniteui-angular/src/lib/combo/combo.pipes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
41 changes: 0 additions & 41 deletions projects/igniteui-angular/src/lib/core/base.ts

This file was deleted.

10 changes: 10 additions & 0 deletions projects/igniteui-angular/src/lib/core/deprecateDecorators.ts
Original file line number Diff line number Diff line change
@@ -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);
Expand Down
1 change: 1 addition & 0 deletions projects/igniteui-angular/src/lib/core/selection.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { Injectable } from '@angular/core';

/** @hidden */
@Injectable({
providedIn: 'root',
})
Expand Down
1 change: 1 addition & 0 deletions projects/igniteui-angular/src/lib/core/touch.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
4 changes: 3 additions & 1 deletion projects/igniteui-angular/src/lib/core/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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)) {
Expand Down Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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[];
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@

/**
* @hidden
*/
export interface IRecordInfo {
index: number;
record: object;
Expand Down
Original file line number Diff line number Diff line change
@@ -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);
Expand Down
Original file line number Diff line number Diff line change
@@ -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[] = [];
Expand Down
6 changes: 6 additions & 0 deletions projects/igniteui-angular/src/lib/dialog/dialog.directives.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import { DOCUMENT } from '@angular/common';
import { Directive, HostBinding } from '@angular/core';

/**
* @hidden
*/
@Directive({
selector: 'igx-dialog-title,[igxDialogTitle]'
})
Expand All @@ -10,6 +13,9 @@ export class IgxDialogTitleDirective {
public defaultStyle = true;
}

/**
* @hidden
*/
@Directive({
selector: 'igx-dialog-actions,[igxDialogActions]'
})
Expand Down
Original file line number Diff line number Diff line change
@@ -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>'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { Directive, HostBinding } from '@angular/core';


/**
* @hidden
*/
@Directive({
selector: '[igxLabel]'
})
Expand Down
11 changes: 11 additions & 0 deletions projects/igniteui-angular/src/lib/directives/mask/mask-helper.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
/**
* @hidden
*/
export const MASK_FLAGS = [ 'C', '&', 'a', 'A', '?', 'L', '9', '0', '#' ];

/**
* @hidden
*/
export const KEYS = {
Ctrl : 17,
Z : 90,
Expand All @@ -8,6 +15,10 @@ export const KEYS = {
DELETE : 46
};


/**
* @hidden
*/
export class MaskHelper {
private _cursor;
public get cursor() {
Expand Down
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
Loading