diff --git a/ionic/components/item/item.ts b/ionic/components/item/item.ts index 786f1ecf9e..753dce0241 100644 --- a/ionic/components/item/item.ts +++ b/ionic/components/item/item.ts @@ -5,7 +5,22 @@ import {ItemPrimarySwipeButtons, ItemSecondarySwipeButtons} from './item-swipe-b import {dom} from 'ionic/util'; /** - * TODO + * @name ionItem + * @classdesc + * Creates a list-item that can easily be swiped, + * deleted, reordered, edited, and more. + * + * @example + * ```html + * + * + * {{item.title}} + *
+ * {{item.note}} + *
+ *
+ *
+ * ``` */ @Component({ selector: 'ion-item,[ion-item]', @@ -24,22 +39,7 @@ import {dom} from 'ionic/util'; }) export class Item { /** - * @name ionItem - * @classdesc - * Creates a list-item that can easily be swiped, - * deleted, reordered, edited, and more. - * - * @example - * ```html - * - * - * {{item.title}} - *
- * {{item.note}} - *
- *
- *
- * ``` + * TODO * @param {ElementRef} elementRef TODO */ constructor(elementRef: ElementRef) { diff --git a/ionic/components/list/list.ts b/ionic/components/list/list.ts index 2fa20834fa..91f9ce6ec4 100644 --- a/ionic/components/list/list.ts +++ b/ionic/components/list/list.ts @@ -7,7 +7,17 @@ import {ListVirtualScroll} from './virtual'; import * as util from 'ionic/util'; /** - * TODO + * @name ionList + * @classdesc + * The List is a widely used interface element in almost any mobile app, and can include + * content ranging from basic text all the way to buttons, toggles, icons, and thumbnails. + * + * Both the list, which contains items, and the list items themselves can be any HTML + * element. + * + * Using the ionList and ionItem components make it easy to support various + * interaction modes such as swipe to edit, drag to reorder, and removing items. + * */ @IonicDirective({ selector: 'ion-list', @@ -19,17 +29,7 @@ import * as util from 'ionic/util'; }) export class List extends Ion { /** - * @name ionList - * @classdesc - * The List is a widely used interface element in almost any mobile app, and can include - * content ranging from basic text all the way to buttons, toggles, icons, and thumbnails. - * - * Both the list, which contains items, and the list items themselves can be any HTML - * element. - * - * Using the ionList and ionItem components make it easy to support various - * interaction modes such as swipe to edit, drag to reorder, and removing items. - * + * TODO * @param {ElementRef} elementRef TODO * @param {IonicConfig} config TODO */ diff --git a/ionic/components/tabs/tab.ts b/ionic/components/tabs/tab.ts index 8161ab68f2..d0673ffc5b 100644 --- a/ionic/components/tabs/tab.ts +++ b/ionic/components/tabs/tab.ts @@ -6,7 +6,15 @@ import {Tabs} from './tabs'; /** - * TODO + * @name ionTab + * @requires ionTabs + * @classdesc + * Contains a tab's content. The content only exists while the given tab is selected. + * + * @example + * ```html + * + * ``` */ @Component({ selector: 'ion-tab', diff --git a/ionic/components/tabs/tabs.ts b/ionic/components/tabs/tabs.ts index 319add8899..3a0d21944d 100644 --- a/ionic/components/tabs/tabs.ts +++ b/ionic/components/tabs/tabs.ts @@ -5,9 +5,28 @@ import {ViewItem} from '../view/view-item'; import {Icon} from '../icon/icon'; import {IonicComponent, IonicView} from '../../config/annotations'; -/** - * TODO - */ + /** + * @name ionTabs + * @classdesc + * Powers a multi-tabbed interface with a Tab Bar and a set of "pages" that can be tabbed through. + * + * Assign any tabs attribute to the element to define its look and feel. + * + * For iOS, tabs will appear at the bottom of the screen. For Android, tabs will be at the top of the screen, below the nav-bar. This follows each OS's design specification, but can be configured with the ionicConfig. + * + * See the ionTab component's documentation for more details on individual tabs. + * + * @example + * ```html + * + * + * + * + * + * ``` + * + */ + @IonicComponent({ selector: 'ion-tabs', defaultProperties: { @@ -31,7 +50,10 @@ import {IonicComponent, IonicView} from '../../config/annotations'; directives: [forwardRef(() => TabButton)] }) export class Tabs extends ViewController { - constructor( + /** + * TODO + */ + constructor( @Optional() hostViewCtrl: ViewController, @Optional() viewItem: ViewItem, injector: Injector,