From 158657a2ecb1025489dc303af0fc888e6f161658 Mon Sep 17 00:00:00 2001 From: Drew Rygh Date: Tue, 8 Sep 2015 15:27:40 -0500 Subject: [PATCH] docs(app): add description and usage --- ionic/components/app/app.ts | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/ionic/components/app/app.ts b/ionic/components/app/app.ts index ee1bdb8153..6d580899b5 100644 --- a/ionic/components/app/app.ts +++ b/ionic/components/app/app.ts @@ -12,7 +12,24 @@ import {Popup} from '../popup/popup'; import {FocusHolder} from '../form/focus-holder'; /** - * TODO + * @name IonicApp + * @description + * The base Ionic class that your app inherits from. By inheriting from this class, you will have access to the Ionic API. + * + * @usage + * ```js + * @App({ + * templateUrl: '/app/app.html', + * }) + * class MyApp { + * + * constructor(app: IonicApp) { + * this.app = app; + * } + * } + * ``` + * Note: Ionic sets `ion-app` as the selector for the app. Setting a custom selector will override this and cause CSS problems. + * */ export class IonicApp {