CRM-20981 - Tweak docblock
authorTim Otten <totten@civicrm.org>
Mon, 19 Mar 2018 22:20:54 +0000 (15:20 -0700)
committerTim Otten <totten@civicrm.org>
Mon, 19 Mar 2018 22:20:54 +0000 (15:20 -0700)
Civi/Angular/AngularLoader.php

index 80cd4906e7e3b9bb4f0e7c1bd1ce612a063bd917..e16cab341984d61d4737f024ee513a2349d84b95 100644 (file)
@@ -182,8 +182,11 @@ class AngularLoader {
    * @param array $settings
    *   A list of settings. Accepted values:
    *    - activeRoute: string, the route to open up immediately
-   *    - defaultRoute: string, use this to redirect the default route to another page
+   *      Ex: '/case/list'
+   *    - defaultRoute: string, use this to redirect the default route (`/`) to another page
+   *      Ex: '/case/list'
    *    - region: string, the place on the page where we should insert the angular app
+   *      Ex: 'page-body'
    * @return AngularLoader
    * @link https://code.angularjs.org/1.5.11/docs/guide/bootstrap
    */