docs: fix doc tags

This commit is contained in:
Drew Rygh
2015-09-08 15:00:14 -05:00
parent e2c01f4b12
commit b95ddaafa2
13 changed files with 31 additions and 35 deletions

View File

@ -17,12 +17,12 @@ import * as util from 'ionic/util';
/** /**
* @name ActionMenu * @name ActionMenu
* @classdesc * @description
* The Action Menu is a slide-up pane that lets the user choose from a set of options. Dangerous options are made obvious. * The Action Menu is a slide-up pane that lets the user choose from a set of options. Dangerous options are made obvious.
* *
* There are easy ways to cancel out of the action sheet, such as tapping the backdrop or even hitting escape on the keyboard for desktop testing. * There are easy ways to cancel out of the action sheet, such as tapping the backdrop or even hitting escape on the keyboard for desktop testing.
* *
* @example * @usage
* ```ts * ```ts
* openMenu() { * openMenu() {
* *

View File

@ -14,12 +14,12 @@ import {TapClick} from '../button/button';
/** /**
* @name ionCheckbox * @name ionCheckbox
* @classdesc * @description
* The checkbox is no different than the HTML checkbox input, except it's styled differently * The checkbox is no different than the HTML checkbox input, except it's styled differently
* *
* See the [Angular 2 Docs](https://angular.io/docs/js/latest/api/forms/) for more info on forms and input. * See the [Angular 2 Docs](https://angular.io/docs/js/latest/api/forms/) for more info on forms and input.
* *
* @example * @usage
* ```html * ```html
* <ion-checkbox checked="true" value="isChecked" ng-control="htmlCtrl"> * <ion-checkbox checked="true" value="isChecked" ng-control="htmlCtrl">
* HTML5 * HTML5

View File

@ -8,7 +8,7 @@ import {hasFocusedTextInput} from '../../util/dom';
/** /**
* @name ionContent * @name ionContent
* @classdesc * @description
* TODO * TODO
* *
*/ */

View File

@ -5,10 +5,10 @@ import {SlideGesture} from 'ionic/gestures/slide-gesture';
/** /**
* @name ionPrimarySwipeButtons * @name ionPrimarySwipeButtons
* @classdesc * @description
* 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)`. * 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 * @usage
* TODO * TODO
*/ */
@Directive({ @Directive({

View File

@ -6,11 +6,11 @@ import {dom} from 'ionic/util';
/** /**
* @name ionItem * @name ionItem
* @classdesc * @description
* Creates a list-item that can easily be swiped, * Creates a list-item that can easily be swiped,
* deleted, reordered, edited, and more. * deleted, reordered, edited, and more.
* *
* @example * @usage
* ```html * ```html
* <ion-list> * <ion-list>
* <ion-item *ng-for="#item of items" (^click)="itemTapped($event, item)"> * <ion-item *ng-for="#item of items" (^click)="itemTapped($event, item)">

View File

@ -8,7 +8,7 @@ import * as util from 'ionic/util';
/** /**
* @name ionList * @name ionList
* @classdesc * @description
* The List is a widely used interface element in almost any mobile app, and can include * 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. * content ranging from basic text all the way to buttons, toggles, icons, and thumbnails.
* *

View File

@ -6,10 +6,10 @@ import * as util from 'ionic/util';
/** /**
* @name ionModal * @name ionModal
* @classdesc * @description
* The Modal is a content pane that can go over the user's main view temporarily. Usually used for making a choice or editing an item. * The Modal is a content pane that can go over the user's main view temporarily. Usually used for making a choice or editing an item.
* *
* @example * @usage
* ```ts * ```ts
* class MyApp { * class MyApp {
* *

View File

@ -8,12 +8,12 @@ import * as util from 'ionic/util';
/** /**
* @name ionPopup * @name ionPopup
* @classdesc * @description
* The Ionic Popup service allows programmatically creating and showing popup windows that require the user to respond in order to continue. * The Ionic Popup service allows programmatically creating and showing popup windows that require the user to respond in order to continue.
* *
* The popup system has support for more flexible versions of the built in `alert()`, `prompt()`, and `confirm()` functions that users are used to, in addition to allowing popups with completely custom content and look. * The popup system has support for more flexible versions of the built in `alert()`, `prompt()`, and `confirm()` functions that users are used to, in addition to allowing popups with completely custom content and look.
* *
* @example * @usage
* ```ts * ```ts
* class myApp { * class myApp {
* *

View File

@ -9,7 +9,7 @@ import {ListHeader} from '../list/list';
/** /**
* @name ionRadioGroup * @name ionRadioGroup
* @classdesc * @description
* A radio group is a group of radio components. * A radio group is a group of radio components.
* *
* Selecting a radio button in the group unselects all others in the group. * Selecting a radio button in the group unselects all others in the group.
@ -18,7 +18,7 @@ import {ListHeader} from '../list/list';
* *
* See the [Angular 2 Docs](https://angular.io/docs/js/latest/api/forms/) for more info on forms and input. * See the [Angular 2 Docs](https://angular.io/docs/js/latest/api/forms/) for more info on forms and input.
* *
* @example * @usage
* ```html * ```html
* <ion-radio-group ng-control="clientside"> * <ion-radio-group ng-control="clientside">
* *
@ -152,12 +152,12 @@ export class RadioGroup extends Ion {
/** /**
* @name ionRadio * @name ionRadio
* @classdesc * @description
* A single radio component. * A single radio component.
* *
* See the [Angular 2 Docs](https://angular.io/docs/js/latest/api/forms/) for more info on forms and input. * See the [Angular 2 Docs](https://angular.io/docs/js/latest/api/forms/) for more info on forms and input.
* *
* @example * @usage
* ```html * ```html
* <ion-radio value="isChecked" checked="true"> * <ion-radio value="isChecked" checked="true">
* Radio Label * Radio Label

View File

@ -7,20 +7,18 @@ import {raf, ready, CSS} from 'ionic/util/dom';
/** /**
* @name ionRefresher * @name ionRefresher
* @classdesc * @description
* Allows you to add pull-to-refresh to an ionContent component. * Allows you to add pull-to-refresh to an ionContent component.
* *
* Place it as the first child of your ionContent or ionScroll element. * Place it as the first child of your ionContent or ionScroll element.
* *
* When refreshing is complete, call `refresher.complete()` from your controller. * When refreshing is complete, call `refresher.complete()` from your controller.
* *
* @example * @usage
* ```html
* <ion-refresher (starting)="doStarting()" (refresh)="doRefresh($event, refresher)" (pulling)="doPulling($event, amt)">
* ```
*
* @example
* ```ts * ```ts
* <ion-refresher (starting)="doStarting()" (refresh)="doRefresh($event, refresher)" (pulling)="doPulling($event, amt)">
*
*
* doRefresh(refresher) { * doRefresh(refresher) {
* console.log('Refreshing!', refresher); * console.log('Refreshing!', refresher);
* *

View File

@ -48,23 +48,21 @@ class MediaSwitch {
/** /**
* @name ionSwitch * @name ionSwitch
* @classdesc * @description
* A switch technically is the same thing as an HTML checkbox input, except it looks different and is easier to use on a touch device. Ionic prefers to wrap the checkbox input with the <label> in order to make the entire toggle easy to tap or drag. * A switch technically is the same thing as an HTML checkbox input, except it looks different and is easier to use on a touch device. Ionic prefers to wrap the checkbox input with the <label> in order to make the entire toggle easy to tap or drag.
* *
* Toggles can also have colors assigned to them, by adding the `toggle-assertive` attribute to assign the assertive color. * Toggles can also have colors assigned to them, by adding the `toggle-assertive` attribute to assign the assertive color.
* *
* See the [Angular 2 Docs](https://angular.io/docs/js/latest/api/forms/) for more info on forms and input. * See the [Angular 2 Docs](https://angular.io/docs/js/latest/api/forms/) for more info on forms and input.
* *
* @example * @usage
* ```html * ```html
* // Create a single switch
* <ion-switch checked="true"> * <ion-switch checked="true">
* Pineapple * Pineapple
* </ion-switch> * </ion-switch>
* ````
* *
* @example * // Create a list of switches:
* Create a list of switch components:
* ```html
* <ion-list> * <ion-list>
* *
* <ion-switch checked="true"> * <ion-switch checked="true">

View File

@ -8,10 +8,10 @@ import {Tabs} from './tabs';
/** /**
* @name ionTab * @name ionTab
* @requires ionTabs * @requires ionTabs
* @classdesc * @description
* Contains a tab's content. The content only exists while the given tab is selected. * Contains a tab's content. The content only exists while the given tab is selected.
* *
* @example * @usage
* ```html * ```html
* <ion-tab tab-title="Heart" tab-icon="ion-ios-heart-outline" [root]="root1"></ion-tab> * <ion-tab tab-title="Heart" tab-icon="ion-ios-heart-outline" [root]="root1"></ion-tab>
* ``` * ```

View File

@ -7,7 +7,7 @@ import {IonicComponent, IonicView} from '../../config/annotations';
/** /**
* @name ionTabs * @name ionTabs
* @classdesc * @description
* Powers a multi-tabbed interface with a Tab Bar and a set of "pages" that can be tabbed through. * 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. * Assign any tabs attribute to the element to define its look and feel.
@ -16,7 +16,7 @@ import {IonicComponent, IonicView} from '../../config/annotations';
* *
* See the ionTab component's documentation for more details on individual tabs. * See the ionTab component's documentation for more details on individual tabs.
* *
* @example * @usage
* ```html * ```html
* <ion-tabs> * <ion-tabs>
* <ion-tab tab-title="Heart" tab-icon="ion-ios-heart-outline" [root]="root1"></ion-tab> * <ion-tab tab-title="Heart" tab-icon="ion-ios-heart-outline" [root]="root1"></ion-tab>