Skip to content

Commit b52700b

Browse files
committed
docs(tab): improve API docs for tab
references #5819
1 parent 932ab42 commit b52700b

File tree

3 files changed

+14
-10
lines changed

3 files changed

+14
-10
lines changed

ionic/components/nav/nav.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {ViewController} from './view-controller';
2020
* Nav automatically animates transitions between pages for you.
2121
*
2222
* For more information on using navigation controllers like Nav or [Tab](../../Tabs/Tab/),
23-
* take a look at the [NavController API reference](../NavController/).
23+
* take a look at the [NavController API Docs](../NavController/).
2424
*
2525
* You must set a root page (where page is any [@Page](../../config/Page/)
2626
* component) to be loaded initially by any Nav you create, using

ionic/components/tabs/tab.ts

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,18 @@ import {TabButton} from './tab-button';
1313
/**
1414
* @name Tab
1515
* @description
16-
* _For basic Tabs usage, see the [Tabs section](../../../../components/#tabs)
17-
* of the Component docs._
16+
* The Tab component, written `<ion-tab>`, is styled based on the mode and should
17+
* be used in conjunction with the [Tabs](../Tabs/) component.
1818
*
19-
* Tab components are basic navigation controllers used with Tabs. Much like
20-
* Nav, they are a subclass of NavController and can be used to navigate
21-
* to pages in and manipulate the navigation stack of a particular tab.
19+
* Each tab has a basic navigation controller. Similar to the [Nav](../../nav/Nav/)
20+
* component, the tab navigation controller is a subclass of
21+
* [NavController](../../nav/NavController). It can be used to navigate and manipulate
22+
* pages in the navigation stack of the tab.
2223
*
2324
* For more information on using navigation controllers like Tab or [Nav](../../nav/Nav/),
24-
* take a look at the [NavController API reference](../NavController/).
25+
* take a look at the [NavController API Docs](../../nav/NavController/).
2526
*
26-
* See the [Tabs API reference](../Tabs/) for more details on configuring Tabs
27-
* and the TabBar.
27+
* See the [Tabs API Docs](../Tabs/) for more details on configuring Tabs.
2828
*
2929
* @usage
3030
* 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';
7171
*
7272
*
7373
* @demo /docs/v2/demos/tabs/
74+
* @see {@link /docs/v2/components#tabs Tabs Component Docs}
75+
* @see {@link ../../tabs/Tabs Tabs API Docs}
76+
* @see {@link ../../nav/Nav Nav API Docs}
77+
* @see {@link ../../nav/NavController NavController API Docs}
7478
*/
7579
@Component({
7680
selector: 'ion-tab',

ionic/decorators/page.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ export interface PageMetadata {
9494
* you may see these tags if you inspect your markup, you don't need to include
9595
* them in your templates.
9696
*
97-
* For more information on how pages are created, see the [NavController API reference](../../components/nav/NavController/#creating_pages)
97+
* For more information on how pages are created, see the [NavController API Docs](../../components/nav/NavController/#creating_pages)
9898
*/
9999
export function Page(config: PageMetadata) {
100100
return function(cls) {

0 commit comments

Comments
 (0)