javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-20 20:33:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(tab): improve API docs for tab

Browse Source 
references #5819
This commit is contained in:
Brandy Carney
2016-04-11 23:04:46 -04:00
parent 932ab42eb1
commit b52700b42e
3 changed files with 14 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
ionic/components/nav/nav.ts
View File

@ -20,7 +20,7 @@ import {ViewController} from './view-controller';
* Nav automatically animates transitions between pages for you. * Nav automatically animates transitions between pages for you.
* *
* For more information on using navigation controllers like Nav or [Tab](../../Tabs/Tab/), * For more information on using navigation controllers like Nav or [Tab](../../Tabs/Tab/),
* take a look at the [NavController API reference](../NavController/). * take a look at the [NavController API Docs](../NavController/).
* *
* You must set a root page (where page is any [@Page](../../config/Page/) * You must set a root page (where page is any [@Page](../../config/Page/)
* component) to be loaded initially by any Nav you create, using * component) to be loaded initially by any Nav you create, using

20
ionic/components/tabs/tab.ts
View File

@ -13,18 +13,18 @@ import {TabButton} from './tab-button';
/** /**
* @name Tab * @name Tab
* @description * @description
* _For basic Tabs usage, see the [Tabs section](../../../../components/#tabs) * The Tab component, written `<ion-tab>`, is styled based on the mode and should
* of the Component docs._ * be used in conjunction with the [Tabs](../Tabs/) component.
* *
* Tab components are basic navigation controllers used with Tabs. Much like * Each tab has a basic navigation controller. Similar to the [Nav](../../nav/Nav/)
* Nav, they are a subclass of NavController and can be used to navigate * component, the tab navigation controller is a subclass of
* to pages in and manipulate the navigation stack of a particular tab. * [NavController](../../nav/NavController). It can be used to navigate and manipulate
* pages in the navigation stack of the tab.
* *
* For more information on using navigation controllers like Tab or [Nav](../../nav/Nav/), * For more information on using navigation controllers like Tab or [Nav](../../nav/Nav/),
* take a look at the [NavController API reference](../NavController/). * take a look at the [NavController API Docs](../../nav/NavController/).
* *
* See the [Tabs API reference](../Tabs/) for more details on configuring Tabs * See the [Tabs API Docs](../Tabs/) for more details on configuring Tabs.
* and the TabBar.
* *
* @usage * @usage
* For most cases, you can give tab a `[root]` property along with the component you want to load. * For most cases, you can give tab a `[root]` property along with the component you want to load.
@ -71,6 +71,10 @@ import {TabButton} from './tab-button';
* *
* *
* @demo /docs/v2/demos/tabs/ * @demo /docs/v2/demos/tabs/
* @see {@link /docs/v2/components#tabs Tabs Component Docs}
* @see {@link ../../tabs/Tabs Tabs API Docs}
* @see {@link ../../nav/Nav Nav API Docs}
* @see {@link ../../nav/NavController NavController API Docs}
*/ */
@Component({ @Component({
selector: 'ion-tab', selector: 'ion-tab',

2
ionic/decorators/page.ts
View File

@ -94,7 +94,7 @@ export interface PageMetadata {
* you may see these tags if you inspect your markup, you don't need to include * you may see these tags if you inspect your markup, you don't need to include
* them in your templates. * them in your templates.
* *
* For more information on how pages are created, see the [NavController API reference](../../components/nav/NavController/#creating_pages) * For more information on how pages are created, see the [NavController API Docs](../../components/nav/NavController/#creating_pages)
*/ */
export function Page(config: PageMetadata) { export function Page(config: PageMetadata) {
return function(cls) { return function(cls) {