diff --git a/src/components/nav/nav-pop.ts b/src/components/nav/nav-pop.ts index 6c690abd62..26d029f892 100644 --- a/src/components/nav/nav-pop.ts +++ b/src/components/nav/nav-pop.ts @@ -36,6 +36,9 @@ export class NavPop { } } +/** + * @private + */ @HostListener('click') onClick(): boolean { // If no target, or if target is _self, prevent default browser behavior diff --git a/src/components/nav/nav-push.ts b/src/components/nav/nav-push.ts index d706e9015f..7fd884ec38 100644 --- a/src/components/nav/nav-push.ts +++ b/src/components/nav/nav-push.ts @@ -66,6 +66,9 @@ export class NavPush { } } +/** + * @private + */ @HostListener('click') onClick(): boolean { if (this._nav) { diff --git a/src/components/scroll/scroll.ts b/src/components/scroll/scroll.ts index db929a9434..f94ccc1060 100644 --- a/src/components/scroll/scroll.ts +++ b/src/components/scroll/scroll.ts @@ -17,10 +17,6 @@ import { isTrueProperty } from '../../util/util'; * * * ``` - * @property {boolean} [scrollX] - whether to enable scrolling along the X axis - * @property {boolean} [scrollY] - whether to enable scrolling along the Y axis; requires the following CSS declaration: ion-scroll { white-space: nowrap; } - * @property {boolean} [zoom] - whether to enable zooming - * @property {number} [maxZoom] - set the max zoom amount for ion-scroll * @demo /docs/v2/demos/src/scroll/ */ @Component({ @@ -44,6 +40,9 @@ export class Scroll { _zoom: boolean = false; _maxZoom: number = 1; + /** + * @input {boolean} whether to enable scrolling along the X axis + */ @Input() get scrollX() { return this._scrollX; @@ -52,6 +51,9 @@ export class Scroll { this._scrollX = isTrueProperty(val); } + /** + * @input {boolean} whether to enable scrolling along the Y axis; requires the following CSS declaration: ion-scroll { white-space: nowrap; } + */ @Input() get scrollY() { return this._scrollY; @@ -60,6 +62,9 @@ export class Scroll { this._scrollY = isTrueProperty(val); } + /** + * @input {boolean} whether to enable zooming + */ @Input() get zoom() { return this._zoom; @@ -68,6 +73,9 @@ export class Scroll { this._zoom = isTrueProperty(val); } + /** + * @input {number} set the max zoom amount for ion-scroll + */ @Input() get maxZoom() { return this._maxZoom; diff --git a/src/components/slides/slides.ts b/src/components/slides/slides.ts index 7cafd4479f..10b92f81d9 100644 --- a/src/components/slides/slides.ts +++ b/src/components/slides/slides.ts @@ -862,6 +862,10 @@ export class Slide { constructor( elementRef: ElementRef, + + /** + * @private + */ @Host() public slides: Slides ) { this.ele = elementRef.nativeElement; @@ -870,6 +874,9 @@ export class Slide { slides.rapidUpdate(); } + /** + * @private + */ ngOnDestroy() { this.slides.rapidUpdate(); } diff --git a/src/components/thumbnail/thumbnail.ts b/src/components/thumbnail/thumbnail.ts index eadefff1f8..1ee344f49c 100644 --- a/src/components/thumbnail/thumbnail.ts +++ b/src/components/thumbnail/thumbnail.ts @@ -4,6 +4,9 @@ import { Directive } from '@angular/core'; * @name Thumbnail * @module ionic * @description + * A Thumbnail is a component that creates a squated image for an item. + * Thumbnail's can be place on the left or right side of an itemt with the `item-left` or `item-right` directive. + * @see {@link /docs/v2/components/#thumbnail-list Thumbnail Component Docs} */ @Directive({ selector: 'ion-thumbnail' diff --git a/src/navigation/view-controller.ts b/src/navigation/view-controller.ts index 9bf1dc9e47..9f66efc1cf 100644 --- a/src/navigation/view-controller.ts +++ b/src/navigation/view-controller.ts @@ -158,21 +158,26 @@ export class ViewController { } /** - * onDidDismiss + * Called when the current viewController has be successfully dismissed */ onDidDismiss(callback: Function) { this._onDidDismiss = callback; } /** - * onWillDismiss + * Called when the current viewController will be dismissed */ onWillDismiss(callback: Function) { this._onWillDismiss = callback; } /** - * dismiss + * Dismiss the current viewController + * @param {any} [data] Data that you want to return when the viewController is dismissed. + * @param {any} [role ] + * @param {NavOptions} NavOptions Options for the dismiss navigation. + * @returns {any} data Returns the data passed in, if any. + * */ dismiss(data?: any, role?: any, navOptions: NavOptions = {}) { let options = merge({}, this._leavingOpts, navOptions);