Skip to content

Commit

Permalink
docs(): minor doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mhartington committed Oct 10, 2016
1 parent c9b1181 commit da62b63
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 24 deletions.
4 changes: 2 additions & 2 deletions src/components/app/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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());
Expand All @@ -170,7 +170,7 @@ export class App {
}

/**
* retuns the root NavController
* @return {NavController} Retuns the root NavController
*/
getRootNav(): NavController {
return this._rootNav;
Expand Down
12 changes: 0 additions & 12 deletions src/components/button/button.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion src/components/fab/fab.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down Expand Up @@ -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);
}
Expand Down
4 changes: 4 additions & 0 deletions src/components/infinite-scroll/infinite-scroll.ts
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,10 @@ export class InfiniteScroll {
_thrPc: number = 0.15;
_init: boolean = false;


/**
* @internal
*/
state: string = STATE_ENABLED;

/**
Expand Down
12 changes: 5 additions & 7 deletions src/components/input/input.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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() {
Expand All @@ -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() {
Expand Down Expand Up @@ -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>();

/**
* @private
* @output {event} Expression to call when the input has focus
*/
@Output() focus: EventEmitter<Event> = new EventEmitter<Event>();

Expand Down
13 changes: 11 additions & 2 deletions src/util/haptic.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ declare var window;

@Injectable()
export class Haptic {

/**
* @internal
*/
plugin: any;

constructor(platform: Platform) {
Expand All @@ -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;
}
Expand Down Expand Up @@ -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) {
Expand All @@ -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) {
Expand Down

0 comments on commit da62b63

Please sign in to comment.