docs(item): document params

This commit is contained in:
Drew Rygh
2015-09-08 13:01:52 -05:00
parent fa8094f520
commit 6e38ba22d0
2 changed files with 9 additions and 6 deletions

View File

@@ -4,6 +4,11 @@ import {Item} from 'ionic/components/item/item';
import {SlideGesture} from 'ionic/gestures/slide-gesture';
/**
* @name ionPrimarySwipeButtons
* @classdesc
* Creates a swipeable button inside a list item, that is visible when the item is swiped to the left by the user. Swiped open buttons can be hidden with `setOpen(false)`.
*
* @example
* TODO
*/
@Directive({
@@ -11,9 +16,8 @@ import {SlideGesture} from 'ionic/gestures/slide-gesture';
})
export class ItemPrimarySwipeButtons {
/**
* TODO
* @param {ElementRef} elementRef TODO
* @param {Item} item TODO
* @param {ElementRef} elementRef A reference to the component's DOM element.
* @param {Item} item The list item containing the swipeable buttons.
*/
constructor(
elementRef: ElementRef,
@@ -27,8 +31,7 @@ export class ItemPrimarySwipeButtons {
}
/**
* TODO
* @param {boolean} isOpen TODO
* @param {boolean} isOpen Whether or not the button should be set to open/visible.
*/
setOpen(isOpen) {
if (isOpen !== this.isOpen) {

View File

@@ -40,7 +40,7 @@ import {dom} from 'ionic/util';
export class Item {
/**
* TODO
* @param {ElementRef} elementRef TODO
* @param {ElementRef} elementRef A reference to the component's DOM element.
*/
constructor(elementRef: ElementRef) {
this._isOpen = false;