docs(api): add links to component sections

This commit is contained in:
Drew Rygh
2015-12-04 13:55:26 -06:00
parent 0b3e0e7c65
commit 28bb668d43
22 changed files with 34 additions and 5 deletions

View File

@ -106,6 +106,8 @@ class ActionSheetCmp {
*
* }
* ```
*
* @see {@link /docs/v2/components#action-sheets ActionSheet Component Docs}
*/
@Injectable()
export class ActionSheet {

View File

@ -26,6 +26,8 @@ import {Config} from '../../config/config';
* @property [fab-bottom] - position a fab button towards the bottom
* @description
* Buttons are simple components in Ionic, can consist of text, an icon, or both, and can be enhanced with a wide range of attributes.
* @see {@link /docs/v2/components#buttons Button Component Docs}
*/
@Directive({
selector: 'button,[button]'

View File

@ -17,6 +17,7 @@ import {Form} from '../../util/form';
* HTML5
* </ion-checkbox>
* ```
* @see {@link /docs/v2/components#checkbox Checkbox Component Docs}
*/
@Component({
selector: 'ion-checkbox',

View File

@ -13,6 +13,7 @@ import {Config} from '../../config/config';
* If there is not an outlined version for the particular icon, it will use the default (full) version.
* @property {string} [ios] - Explicitly set the icon to use on iOS.
* @property {string} [md] - Explicitly set the icon to use on Android.
* @see {@link /docs/v2/components#icons Icon Component Docs}
*
*/
@Directive({

View File

@ -37,6 +37,8 @@ import {Component} from 'angular2/angular2';
* </ion-list>
*
* ```
* @see {@link /docs/v2/components#lists List Component Docs}
* @see {@link ../../list/List List API Docs}
*/
@Component({
selector: 'ion-item,[ion-item]',

View File

@ -16,6 +16,7 @@ import * as util from 'ionic/util';
* Using the List and Item components make it easy to support various
* interaction modes such as swipe to edit, drag to reorder, and removing items.
* @demo /docs/v2/demos/list/
* @see {@link /docs/v2/components#lists List Component Docs}
*
*
*/

View File

@ -6,6 +6,8 @@ import {IonicApp} from '../app/app';
/**
* TODO
* @see {@link /docs/v2/components#menus Menu Component Docs}
* @see {@link ../../menu/Menu Menu API Docs}
*/
@Directive({
selector: '[menu-close]',

View File

@ -8,6 +8,8 @@ import {Navbar} from '../navbar/navbar';
/**
* TODO
* @see {@link /docs/v2/components#menus Menu Component Docs}
* @see {@link ../../menu/Menu Menu API Docs}
*/
@Directive({
selector: '[menu-toggle]',

View File

@ -7,6 +7,7 @@ import {Animation} from 'ionic/animations/animation';
* Base class which is extended by the various types. Each
* type will provide their own animations for open and close
* and registers itself with Menu.
* @private
*/
export class MenuType {

View File

@ -42,6 +42,10 @@ import * as gestures from './menu-gestures';
* ```html
* <ion-menu [content]="contentRef" type="overlay"></ion-menu>
* ```
* @see {@link /docs/v2/components#menus Menu Component Docs}
* @see {@link /docs/v2/components#navigation Navigation Component Docs}
* @see {@link ../../nav/Nav Nav API Docs}
*
*/
@Component({
selector: 'ion-menu',

View File

@ -33,6 +33,7 @@ import {extend} from 'ionic/util';
*
* }
* ```
* @see {@link /docs/v2/components#modals Modal Component Docs}
*/
@Injectable()
export class Modal {

View File

@ -97,6 +97,7 @@ import {raf, rafFrames} from '../../util/dom';
* - `onPageWillUnload` - Runs when the page is about to be destroyed and have its elements removed.
* - `onPageDidUnload` - Runs after the page has been destroyed and its elements have been removed.
*
* @see {@link /docs/v2/components#navigation Navigation Component Docs}
*/
export class NavController extends Ion {

View File

@ -36,6 +36,7 @@ import {NavRegistry} from './nav-registry';
* ```html
* <button [nav-push]="[pushPage, params]"></button>
* ```
* @see {@link /docs/v2/components#navigation Navigation Component Docs}
*/
@Directive({
selector: '[nav-push]',

View File

@ -96,6 +96,7 @@ import {ViewController} from './view-controller';
* </pre>
* </div>
*
* @see {@link /docs/v2/components#navigation Navigation Component Docs}
*/
@ConfigComponent({
selector: 'ion-nav',

View File

@ -61,6 +61,7 @@ import {extend} from '../../util/util';
* }
* }
* ```
* @see {@link /docs/v2/components#popups Popup Component Docs}
*/
@Injectable()
export class Popup {

View File

@ -40,6 +40,7 @@ import {ListHeader} from '../list/list';
*
* </ion-list>
* ```
* @see {@link /docs/v2/components#radio Radio Component Docs}
*/
@Directive({
selector: '[radio-group]',
@ -162,6 +163,7 @@ export class RadioGroup extends Ion {
* </ion-radio>
* ```
*
* @see {@link /docs/v2/components#radio Radio Component Docs}
*/
@Component({
selector: 'ion-radio',

View File

@ -20,6 +20,7 @@ import {Icon} from '../icon/icon';
* @property [show-cancel] - shows the cancel button based on boolean value passed in
* @property [cancel-text] - sets the cancel button text to the value passed in
* @property [cancel-action] - the function that gets called by clicking the cancel button
* @see {@link /docs/v2/components#search Search Component Docs}
*/
@ConfigComponent({
selector: 'ion-searchbar',

View File

@ -36,6 +36,8 @@ import {Config} from '../../config/config';
* </ion-segment>
* </form>
* ```
*
* @see {@link /docs/v2/components#segment Segment Component Docs}
*/
@Directive({
selector: 'ion-segment'

View File

@ -27,6 +27,7 @@ import {Scroll} from '../scroll/scroll';
*
* Licensed under MIT
*
* @see {@link /docs/v2/components#slides Slides Component Docs}
*/
@Component({
selector: 'ion-slides',

View File

@ -64,6 +64,7 @@ class MediaSwitch {
* </ion-list>
* ```
*
* @see {@link /docs/v2/components#switch Switch Component Docs}
*/
@Component({
selector: 'ion-switch',

View File

@ -31,8 +31,8 @@ import {rafFrames} from '../../util/dom';
* individual Tab components. On iOS, the TabBar is placed on the bottom of
* the screen, while on Android it is at the top.
*
* See the [Tab API reference](../Tab/) for more details on individual Tab components.
*
* @see {@link /docs/v2/components#tabs Tabs Component Docs}
* @see {@link ../Tab Tab API Docs}
*/
@ConfigComponent({
selector: 'ion-tabs',

View File

@ -223,7 +223,6 @@ Delegate: <$ doc.delegate $>
<@- if doc.see @>
<h2>Related</h2>
<@ for s in doc.see @>
<$ s | safe $>
<@- endfor -@>