From ff7b05ed23690f00c8779c07bea789d65997bca9 Mon Sep 17 00:00:00 2001 From: Ken Sodemann Date: Mon, 25 Sep 2017 21:37:41 -0500 Subject: [PATCH] docs(documentation): cosmetically improve the documentation --- .../action-sheet/action-sheet-controller.ts | 8 ++++---- .../src/components/alert/alert-controller.ts | 14 ++++++-------- .../src/components/loading/loading-controller.ts | 10 ++++------ .../src/components/modal/modal-controller.ts | 6 ++---- .../src/components/toast/toast-controller.ts | 6 ++---- .../ionic-angular/src/navigation/nav-params.ts | 4 ++-- packages/ionic-angular/src/platform/keyboard.ts | 4 +--- packages/ionic-angular/src/util/events.ts | 3 ++- .../ionic-angular/src/util/ionic-error-handler.ts | 6 +++--- 9 files changed, 26 insertions(+), 35 deletions(-) diff --git a/packages/ionic-angular/src/components/action-sheet/action-sheet-controller.ts b/packages/ionic-angular/src/components/action-sheet/action-sheet-controller.ts index bee0b68355..078a99836d 100644 --- a/packages/ionic-angular/src/components/action-sheet/action-sheet-controller.ts +++ b/packages/ionic-angular/src/components/action-sheet/action-sheet-controller.ts @@ -39,10 +39,10 @@ import { Config } from '../../config/config'; * * export class MyClass{ * - * constructor(public actionSheetCtrl: ActionSheetController) {} + * constructor(public actionSheetCtrl: ActionSheetController) { } * * presentActionSheet() { - * let actionSheet = this.actionSheetCtrl.create({ + * const actionSheet = this.actionSheetCtrl.create({ * title: 'Modify your album', * buttons: [ * { @@ -115,14 +115,14 @@ import { Config } from '../../config/config'; * out first, *then* start the next transition. * * ```ts - * let actionSheet = this.actionSheetCtrl.create({ + * const actionSheet = this.actionSheetCtrl.create({ * title: 'Hello', * buttons: [{ * text: 'Ok', * handler: () => { * // user has clicked the action sheet button * // begin the action sheet's dimiss transition - * let navTransition = actionSheet.dismiss(); + * const navTransition = actionSheet.dismiss(); * * // start some async method * someAsyncOperation().then(() => { diff --git a/packages/ionic-angular/src/components/alert/alert-controller.ts b/packages/ionic-angular/src/components/alert/alert-controller.ts index 6d8c83de6f..05f520695c 100644 --- a/packages/ionic-angular/src/components/alert/alert-controller.ts +++ b/packages/ionic-angular/src/components/alert/alert-controller.ts @@ -51,12 +51,10 @@ import { Config } from '../../config/config'; * ```ts * import { AlertController } from 'ionic-angular'; * - * constructor(private alertCtrl: AlertController) { - * - * } + * constructor(private alertCtrl: AlertController) { } * * presentAlert() { - * let alert = this.alertCtrl.create({ + * const alert = this.alertCtrl.create({ * title: 'Low battery', * subTitle: '10% of battery remaining', * buttons: ['Dismiss'] @@ -65,7 +63,7 @@ import { Config } from '../../config/config'; * } * * presentConfirm() { - * let alert = this.alertCtrl.create({ + * const alert = this.alertCtrl.create({ * title: 'Confirm purchase', * message: 'Do you want to buy this book?', * buttons: [ @@ -88,7 +86,7 @@ import { Config } from '../../config/config'; * } * * presentPrompt() { - * let alert = this.alertCtrl.create({ + * const alert = this.alertCtrl.create({ * title: 'Login', * inputs: [ * { @@ -181,14 +179,14 @@ import { Config } from '../../config/config'; * out first, *then* start the next transition. * * ```ts - * let alert = this.alertCtrl.create({ + * const alert = this.alertCtrl.create({ * title: 'Hello', * buttons: [{ * text: 'Ok', * handler: () => { * // user has clicked the alert button * // begin the alert's dismiss transition - * let navTransition = alert.dismiss(); + * const navTransition = alert.dismiss(); * * // start some async method * someAsyncOperation().then(() => { diff --git a/packages/ionic-angular/src/components/loading/loading-controller.ts b/packages/ionic-angular/src/components/loading/loading-controller.ts index c0f80b25e1..028ceebc10 100644 --- a/packages/ionic-angular/src/components/loading/loading-controller.ts +++ b/packages/ionic-angular/src/components/loading/loading-controller.ts @@ -49,12 +49,10 @@ import { LoadingOptions } from './loading-options'; * ```ts * import { LoadingController } from 'ionic-angular'; * - * constructor(public loadingCtrl: LoadingController) { - * - * } + * constructor(public loadingCtrl: LoadingController) { } * * presentLoadingDefault() { - * let loading = this.loadingCtrl.create({ + * const loading = this.loadingCtrl.create({ * content: 'Please wait...' * }); * @@ -66,7 +64,7 @@ import { LoadingOptions } from './loading-options'; * } * * presentLoadingCustom() { - * let loading = this.loadingCtrl.create({ + * const loading = this.loadingCtrl.create({ * spinner: 'hide', * content: ` *
@@ -83,7 +81,7 @@ import { LoadingOptions } from './loading-options'; * } * * presentLoadingText() { - * let loading = this.loadingCtrl.create({ + * const loading = this.loadingCtrl.create({ * spinner: 'hide', * content: 'Loading Please Wait...' * }); diff --git a/packages/ionic-angular/src/components/modal/modal-controller.ts b/packages/ionic-angular/src/components/modal/modal-controller.ts index 6752e9b9aa..a4a241228b 100644 --- a/packages/ionic-angular/src/components/modal/modal-controller.ts +++ b/packages/ionic-angular/src/components/modal/modal-controller.ts @@ -38,12 +38,10 @@ import { DeepLinker } from '../../navigation/deep-linker'; * @Component(...) * class HomePage { * - * constructor(public modalCtrl: ModalController) { - * - * } + * constructor(public modalCtrl: ModalController) { } * * presentProfileModal() { - * let profileModal = this.modalCtrl.create(Profile, { userId: 8675309 }); + * const profileModal = this.modalCtrl.create(Profile, { userId: 8675309 }); * profileModal.present(); * } * diff --git a/packages/ionic-angular/src/components/toast/toast-controller.ts b/packages/ionic-angular/src/components/toast/toast-controller.ts index ef4ae3dbe3..01f5037cec 100644 --- a/packages/ionic-angular/src/components/toast/toast-controller.ts +++ b/packages/ionic-angular/src/components/toast/toast-controller.ts @@ -37,12 +37,10 @@ import { ToastOptions } from './toast-options'; * * @usage * ```ts - * constructor(private toastCtrl: ToastController) { - * - * } + * constructor(private toastCtrl: ToastController) { } * * presentToast() { - * let toast = this.toastCtrl.create({ + * const toast = this.toastCtrl.create({ * message: 'User was added successfully', * duration: 3000, * position: 'top' diff --git a/packages/ionic-angular/src/navigation/nav-params.ts b/packages/ionic-angular/src/navigation/nav-params.ts index 8f73aac216..99d7fe9ba1 100644 --- a/packages/ionic-angular/src/navigation/nav-params.ts +++ b/packages/ionic-angular/src/navigation/nav-params.ts @@ -11,9 +11,9 @@ * import { NavParams } from 'ionic-angular'; * * export class MyClass { - * constructor(public navParams: NavParams) { + * constructor(navParams: NavParams) { * // userParams is an object we have in our nav-parameters - * this.navParams.get('userParams'); + * const params = navParams.get('userParams'); * } * } * ``` diff --git a/packages/ionic-angular/src/platform/keyboard.ts b/packages/ionic-angular/src/platform/keyboard.ts index fa3d4b12f3..fa05f8b526 100644 --- a/packages/ionic-angular/src/platform/keyboard.ts +++ b/packages/ionic-angular/src/platform/keyboard.ts @@ -16,9 +16,7 @@ import { Platform } from './platform'; * @usage * ```ts * export class MyClass { - * constructor(public keyboard: Keyboard) { - * - * } + * constructor(public keyboard: Keyboard) { } * } * ``` */ diff --git a/packages/ionic-angular/src/util/events.ts b/packages/ionic-angular/src/util/events.ts index 0d88a67a1f..d3a48426ee 100644 --- a/packages/ionic-angular/src/util/events.ts +++ b/packages/ionic-angular/src/util/events.ts @@ -13,7 +13,8 @@ import { ScrollView } from './scroll-view'; * import { Events } from 'ionic-angular'; * * // first page (publish an event when a user is created) - * constructor(public events: Events) {} + * constructor(public events: Events) { } + * * createUser(user) { * console.log('User created!') * events.publish('user:created', user, Date.now()); diff --git a/packages/ionic-angular/src/util/ionic-error-handler.ts b/packages/ionic-angular/src/util/ionic-error-handler.ts index 68eb683e5c..c152383ba0 100644 --- a/packages/ionic-angular/src/util/ionic-error-handler.ts +++ b/packages/ionic-angular/src/util/ionic-error-handler.ts @@ -10,13 +10,13 @@ import { ErrorHandler } from '@angular/core'; * ### IonicErrorHandler Example * * ```typescript - * import { NgModule, ErrorHandler } from '@angular/core'; + * import { ErrorHandler, NgModule } from '@angular/core'; * import { IonicErrorHandler } from 'ionic-angular'; * * @NgModule({ * providers: [{ provide: ErrorHandler, useClass: IonicErrorHandler }] * }) - * class AppModule {} + * class AppModule { } * ``` * * @@ -35,7 +35,7 @@ import { ErrorHandler } from '@angular/core'; * @NgModule({ * providers: [{ provide: ErrorHandler, useClass: MyErrorHandler }] * }) - * class AppModule {} + * class AppModule { } * ``` * * More information about Angular's [`ErrorHandler`](https://angular.io/docs/ts/latest/api/core/index/ErrorHandler-class.html).