From 4baa5b1e0c23e045db29b3c110b5895ee56af64c Mon Sep 17 00:00:00 2001 From: mhartington Date: Mon, 26 Sep 2016 14:28:11 -0400 Subject: [PATCH] docs(): update docs --- src/components/app/app.ts | 4 +++- src/components/avatar/avatar.ts | 3 +++ src/components/button/button.ts | 1 + src/components/fab/fab.ts | 17 +++++++++++++++++ src/components/grid/grid.ts | 3 +++ src/config/config.ts | 9 +++++++++ 6 files changed, 36 insertions(+), 1 deletion(-) diff --git a/src/components/app/app.ts b/src/components/app/app.ts index 17602ed0e4..54edcc32dd 100644 --- a/src/components/app/app.ts +++ b/src/components/app/app.ts @@ -11,7 +11,9 @@ import { ViewController } from '../../navigation/view-controller'; /** - * Ionic App + * @name App + * @description + * App is a utility class used in Ionic to get information about various aspects of an app */ @Injectable() export class App { diff --git a/src/components/avatar/avatar.ts b/src/components/avatar/avatar.ts index 4b8cc660a9..fa845adde8 100644 --- a/src/components/avatar/avatar.ts +++ b/src/components/avatar/avatar.ts @@ -4,6 +4,9 @@ import { Directive } from '@angular/core'; * @name Avatar * @module ionic * @description + * An Avatar is a component that creates a circular image for an item. + * Avatar's can be place on the left or right side of an itemt with the `item-left` or `item-right` directive. + * @see {@link /docs/v2/components/#avatar-list Avatar Component Docs} */ @Directive({ selector: 'ion-avatar' diff --git a/src/components/button/button.ts b/src/components/button/button.ts index 6f8eeb6fc2..fa6674ce42 100644 --- a/src/components/button/button.ts +++ b/src/components/button/button.ts @@ -263,6 +263,7 @@ export class Button extends Ion { } } + /** @private */ ngAfterContentInit() { this._init = true; this._assignCss(true); diff --git a/src/components/fab/fab.ts b/src/components/fab/fab.ts index 14622d33d7..51f4751afb 100755 --- a/src/components/fab/fab.ts +++ b/src/components/fab/fab.ts @@ -102,6 +102,23 @@ export class FabButton extends Ion { /** * @name FabList + * @description + * `ion-fab-list` is a container for multiple FAB buttons. They are components of `ion-fab` and allow you to specificy the buttons position, left, right, top, bottom. + * @usage + * + * ```html + * + * + * + * + * + * + * + * + * + * + * + * ``` * @module ionic * * @demo /docs/v2/demos/fab/ diff --git a/src/components/grid/grid.ts b/src/components/grid/grid.ts index 8e72340bbc..51cb758dfc 100644 --- a/src/components/grid/grid.ts +++ b/src/components/grid/grid.ts @@ -1,6 +1,7 @@ import { Directive } from '@angular/core'; /** + * @private * @name Grid * @module ionic * @description @@ -13,6 +14,7 @@ export class Grid { } /** + * @private * @name Row * @module ionic * @description @@ -25,6 +27,7 @@ export class Row { } /** + * @private * @name Column * @module ionic * @description diff --git a/src/config/config.ts b/src/config/config.ts index 7ce49f855a..b08360133f 100644 --- a/src/config/config.ts +++ b/src/config/config.ts @@ -122,6 +122,9 @@ export class Config { */ platform: Platform; + /** + * @private + */ init(config: any, queryParams: QueryParams, platform: Platform) { this._s = config && isObject(config) && !isArray(config) ? config : {}; this._qp = queryParams; @@ -379,8 +382,14 @@ export class Config { } +/** + * @private + */ export const ConfigToken = new OpaqueToken('USERCONFIG'); +/** + * @private + */ export function setupConfig(userConfig: any, queryParams: QueryParams, platform: Platform): Config { const config = new Config(); config.init(userConfig, queryParams, platform);