From da62b63253094ebbfdac1345bcc999bc91d5cb33 Mon Sep 17 00:00:00 2001 From: mhartington Date: Mon, 10 Oct 2016 09:12:58 -0400 Subject: [PATCH] docs(): minor doc updates --- src/components/app/app.ts | 4 ++-- src/components/button/button.ts | 12 ------------ src/components/fab/fab.ts | 4 +++- src/components/infinite-scroll/infinite-scroll.ts | 4 ++++ src/components/input/input.ts | 12 +++++------- src/util/haptic.ts | 13 +++++++++++-- 6 files changed, 25 insertions(+), 24 deletions(-) diff --git a/src/components/app/app.ts b/src/components/app/app.ts index 54edcc32dd..1a8658b6b3 100644 --- a/src/components/app/app.ts +++ b/src/components/app/app.ts @@ -145,7 +145,7 @@ export class App { /** * Boolean if the app is actively scrolling or not. - * @return {boolean} + * @return {boolean} returns true or false */ isScrolling(): boolean { return (this._scrollTime + 48 > Date.now()); @@ -170,7 +170,7 @@ export class App { } /** - * retuns the root NavController + * @return {NavController} Retuns the root NavController */ getRootNav(): NavController { return this._rootNav; diff --git a/src/components/button/button.ts b/src/components/button/button.ts index e08ef46c35..75255f132a 100644 --- a/src/components/button/button.ts +++ b/src/components/button/button.ts @@ -8,21 +8,9 @@ import { isTrueProperty } from '../../util/util'; /** * @name Button * @module ionic - * * @description * Buttons are simple components in Ionic. They can consist of text and icons * and be enhanced by a wide range of attributes. - * - * @property [outline] - A transparent button with a border. - * @property [clear] - A transparent button without a border. - * @property [round] - A button with rounded corners. - * @property [block] - A button that fills its parent container with a border-radius. - * @property [full] - A button that fills its parent container without a border-radius or borders on the left/right. - * @property [small] - A button with size small. - * @property [large] - A button with size large. - * @property [disabled] - A disabled button. - * @property [color] - Dynamically set which predefined color this button should use (e.g. primary, secondary, danger, etc). - * * @usage * * ```html diff --git a/src/components/fab/fab.ts b/src/components/fab/fab.ts index 792eb56457..f48aa70631 100755 --- a/src/components/fab/fab.ts +++ b/src/components/fab/fab.ts @@ -33,7 +33,6 @@ import { nativeTimeout } from '../../util/dom'; * See [ion-fab] to learn more information about how to position the fab button. * * @property [mini] - Makes a fab button with a reduced size. - * @property [color] - Dynamically set which predefined color this button should use (e.g. primary, secondary, danger, etc). * * @usage * @@ -165,6 +164,9 @@ export class FabList { this.setElementClass('fab-list-active', visible); } + /** + * @internal + */ setElementClass(className: string, add: boolean) { this._renderer.setElementClass(this._elementRef.nativeElement, className, add); } diff --git a/src/components/infinite-scroll/infinite-scroll.ts b/src/components/infinite-scroll/infinite-scroll.ts index 5fa1291aca..07219d6854 100644 --- a/src/components/infinite-scroll/infinite-scroll.ts +++ b/src/components/infinite-scroll/infinite-scroll.ts @@ -103,6 +103,10 @@ export class InfiniteScroll { _thrPc: number = 0.15; _init: boolean = false; + + /** + * @internal + */ state: string = STATE_ENABLED; /** diff --git a/src/components/input/input.ts b/src/components/input/input.ts index bb68550fdd..8c1a4a30de 100644 --- a/src/components/input/input.ts +++ b/src/components/input/input.ts @@ -29,8 +29,6 @@ import { Platform } from '../../platform/platform'; * An `ion-input` is **not** used for non-text type inputs, such as a * `checkbox`, `radio`, `toggle`, `range`, `select`, etc. * - * @property [type] - The HTML input type (text, password, email, number, search, tel, or url) - * @property [clearInput] - A clear icon will appear in the input when there is a value. Clicking it clears the input. * * @usage * ```html @@ -106,12 +104,12 @@ export class TextInput extends InputBase { _clearInput: boolean = false; /** - * @private + * @input {string} The placeholder for the input */ @Input() placeholder: string = ''; /** - * @private + * @input {bool} A clear icon will appear in the input when there is a value. Clicking it clears the input. */ @Input() get clearInput() { @@ -133,7 +131,7 @@ export class TextInput extends InputBase { } /** - * @private + * @input {string} The HTML input type (text, password, email, number, search, tel, or url) */ @Input() get type() { @@ -179,12 +177,12 @@ export class TextInput extends InputBase { } /** - * @private + * @output {event} Expression to call when the input no longer has focus */ @Output() blur: EventEmitter = new EventEmitter(); /** - * @private + * @output {event} Expression to call when the input has focus */ @Output() focus: EventEmitter = new EventEmitter(); diff --git a/src/util/haptic.ts b/src/util/haptic.ts index e657d85646..d1f8d9f940 100644 --- a/src/util/haptic.ts +++ b/src/util/haptic.ts @@ -26,6 +26,10 @@ declare var window; @Injectable() export class Haptic { + + /** + * @internal + */ plugin: any; constructor(platform: Platform) { @@ -34,6 +38,11 @@ export class Haptic { }); } + /** + * Check to see if the Haptic Plugin is available + * @return {boolean} Retuns true or false if the plugin is available + * + */ available() { return !!this.plugin; } @@ -85,7 +94,7 @@ export class Haptic { /** * Use this to indicate success/failure/warning to the user. - * options should be of the type { type: 'success' } (or 'warning'/'error') + * options should be of the type `{ type: 'success' }` (or `warning`/`error`) */ notification(options: { type: string }) { if (!this.plugin) { @@ -97,7 +106,7 @@ export class Haptic { /** * Use this to indicate success/failure/warning to the user. - * options should be of the type { style: 'light' } (or 'medium'/'heavy') + * options should be of the type `{ style: 'light' }` (or `medium`/`heavy`) */ impact(options: { style: string }) { if (!this.plugin) {