docs(): minor doc updates

This commit is contained in:
mhartington
2016-10-10 09:12:58 -04:00
parent c9b11811ed
commit da62b63253
6 changed files with 25 additions and 24 deletions

View File

@ -145,7 +145,7 @@ export class App {
/** /**
* Boolean if the app is actively scrolling or not. * Boolean if the app is actively scrolling or not.
* @return {boolean} * @return {boolean} returns true or false
*/ */
isScrolling(): boolean { isScrolling(): boolean {
return (this._scrollTime + 48 > Date.now()); 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 { getRootNav(): NavController {
return this._rootNav; return this._rootNav;

View File

@ -8,21 +8,9 @@ import { isTrueProperty } from '../../util/util';
/** /**
* @name Button * @name Button
* @module ionic * @module ionic
*
* @description * @description
* Buttons are simple components in Ionic. They can consist of text and icons * Buttons are simple components in Ionic. They can consist of text and icons
* and be enhanced by a wide range of attributes. * 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 * @usage
* *
* ```html * ```html

View File

@ -33,7 +33,6 @@ import { nativeTimeout } from '../../util/dom';
* See [ion-fab] to learn more information about how to position the fab button. * 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 [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 * @usage
* *
@ -165,6 +164,9 @@ export class FabList {
this.setElementClass('fab-list-active', visible); this.setElementClass('fab-list-active', visible);
} }
/**
* @internal
*/
setElementClass(className: string, add: boolean) { setElementClass(className: string, add: boolean) {
this._renderer.setElementClass(this._elementRef.nativeElement, className, add); this._renderer.setElementClass(this._elementRef.nativeElement, className, add);
} }

View File

@ -103,6 +103,10 @@ export class InfiniteScroll {
_thrPc: number = 0.15; _thrPc: number = 0.15;
_init: boolean = false; _init: boolean = false;
/**
* @internal
*/
state: string = STATE_ENABLED; state: string = STATE_ENABLED;
/** /**

View File

@ -29,8 +29,6 @@ import { Platform } from '../../platform/platform';
* An `ion-input` is **not** used for non-text type inputs, such as a * An `ion-input` is **not** used for non-text type inputs, such as a
* `checkbox`, `radio`, `toggle`, `range`, `select`, etc. * `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 * @usage
* ```html * ```html
@ -106,12 +104,12 @@ export class TextInput extends InputBase {
_clearInput: boolean = false; _clearInput: boolean = false;
/** /**
* @private * @input {string} The placeholder for the input
*/ */
@Input() placeholder: string = ''; @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() @Input()
get clearInput() { 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() @Input()
get type() { 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<Event> = new EventEmitter<Event>(); @Output() blur: EventEmitter<Event> = new EventEmitter<Event>();
/** /**
* @private * @output {event} Expression to call when the input has focus
*/ */
@Output() focus: EventEmitter<Event> = new EventEmitter<Event>(); @Output() focus: EventEmitter<Event> = new EventEmitter<Event>();

View File

@ -26,6 +26,10 @@ declare var window;
@Injectable() @Injectable()
export class Haptic { export class Haptic {
/**
* @internal
*/
plugin: any; plugin: any;
constructor(platform: Platform) { 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() { available() {
return !!this.plugin; return !!this.plugin;
} }
@ -85,7 +94,7 @@ export class Haptic {
/** /**
* Use this to indicate success/failure/warning to the user. * 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 }) { notification(options: { type: string }) {
if (!this.plugin) { if (!this.plugin) {
@ -97,7 +106,7 @@ export class Haptic {
/** /**
* Use this to indicate success/failure/warning to the user. * 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 }) { impact(options: { style: string }) {
if (!this.plugin) { if (!this.plugin) {