docs(): hide methods not requiring docs

This commit is contained in:
Adam Bradley
2016-01-27 14:27:33 -06:00
parent 4435451694
commit dbc681fb7c
11 changed files with 108 additions and 15 deletions

View File

@ -41,6 +41,10 @@ export class Button {
private _colors: Array<string> = []; // primary/secondary
private _icon: string = null; // left/right/only
private _disabled: boolean = false; // disabled
/**
* @private
*/
isItem: boolean;
@Input() color: string;

View File

@ -63,6 +63,9 @@ export class Checkbox {
private _disabled: any = false;
private _labelId: string;
/**
* @private
*/
id: string;
@Input() value: string = '';

View File

@ -76,6 +76,9 @@ export class Content extends Ion {
}
}
/**
* @private
*/
ngOnDestroy() {
this.scrollElement.removeEventListener('scroll', this._onScroll);
}
@ -151,6 +154,7 @@ export class Content extends Ion {
}
/**
* @private
* Adds the specified touchmove handler to the content's scroll element.
*
* ```ts

View File

@ -458,6 +458,9 @@ let menuTypes:{ [name: string]: new(...args: any[]) => MenuType } = {};
let menuIds:number = 0;
/**
* @private
*/
@Directive({
selector: '.backdrop',
host: {

View File

@ -34,11 +34,34 @@ export class ViewController {
private _pgRef: ElementRef;
protected _nav: NavController;
/**
* @private
*/
id: string;
/**
* @private
*/
instance: any = {};
/**
* @private
*/
state: string = '';
/**
* @private
*/
viewType: string = '';
/**
* @private
*/
onReady: any;
/**
* @private
*/
zIndex: number;
@Output() private _emitter: EventEmitter<any> = new EventEmitter();
@ -49,6 +72,9 @@ export class ViewController {
this._emitter.subscribe(callback);
}
/**
* @private
*/
emit(data) {
this._emitter.emit(data);
}
@ -62,18 +88,30 @@ export class ViewController {
return this._nav.remove(this._nav.indexOf(this), 1, this._leavingOpts);
}
/**
* @private
*/
setNav(navCtrl) {
this._nav = navCtrl;
}
/**
* @private
*/
getTransitionName(direction) {
return this._nav && this._nav.config.get('pageTransition');
}
/**
* @private
*/
getNavParams() {
return new NavParams(this.data);
}
/**
* @private
*/
setLeavingOpts(opts) {
this._leavingOpts = opts;
}
@ -174,6 +212,9 @@ export class ViewController {
}
}
/**
* @private
*/
setZIndex(zIndex: number, renderer: Renderer) {
if (this._pgRef && zIndex !== this.zIndex) {
this.zIndex = zIndex;

View File

@ -287,18 +287,25 @@ export class Searchbar extends Ion {
* @private
* Write a new value to the element.
*/
public writeValue(value: any) {
writeValue(value: any) {
this.value = value;
}
public onChange = (_:any) => {};
public onTouched = () => {};
/**
* @private
*/
onChange = (_:any) => {};
/**
* @private
*/
onTouched = () => {};
/**
* @private
* Set the function to be called when the control receives a change event.
*/
public registerOnChange(fn:(_:any) => {}):void {
registerOnChange(fn:(_:any) => {}):void {
this.onChange = fn;
}
@ -306,7 +313,7 @@ export class Searchbar extends Ion {
* @private
* Set the function to be called when the control receives a touch event.
*/
public registerOnTouched(fn:() => {}):void {
registerOnTouched(fn:() => {}):void {
this.onTouched = fn;
}
}

View File

@ -138,8 +138,6 @@ export class SegmentButton {
})
export class Segment {
value: string;
onChange = (_) => {};
onTouched = (_) => {};
@Output() change: EventEmitter<SegmentButton> = new EventEmitter();
@ -183,6 +181,14 @@ export class Segment {
}
}
/**
* @private
*/
onChange = (_) => {};
/**
* @private
*/
onTouched = (_) => {};
/**
* @private

View File

@ -102,6 +102,9 @@ export class Tab extends NavController {
private _loaded: boolean;
private _loadTimer: any;
/**
* @private
*/
btn: TabButton;
@Input() root: Type;

View File

@ -71,7 +71,14 @@ export class Tabs extends Ion {
private _onReady = null;
private _useHighlight: boolean;
/**
* @private
*/
id: number;
/**
* @private
*/
navbarContainerRef: ViewContainerRef;
subPages: boolean;

View File

@ -96,7 +96,11 @@ import {isObject, isDefined, isFunction, isArray} from '../util/util';
export class Config {
private _c: any = {};
private _s: any = {};
public platform: Platform;
/**
* @private
*/
platform: Platform;
constructor(config?) {
this._s = config && isObject(config) && !isArray(config) ? config : {};
@ -281,6 +285,13 @@ export class Config {
return this._c[key];
}
/**
* @name getBoolean
* @description
* Same as `get()`, however always returns a boolean value.
*
* @param {String} [key] - the key for the config value
*/
getBoolean(key: string): boolean {
let val = this.get(key);
return (val || val === 'true') ? true : false;

View File

@ -35,7 +35,11 @@ export class Platform {
private _readyResolve: any;
private _engineReady: any;
private _resizeTimer: any;
public platformOverride: string;
/**
* @private
*/
platformOverride: string;
constructor(platforms=[]) {
this._platforms = platforms;