Improved documentation of crmPageTitle directive.

Documented assumption that AngularJS base page be named "CiviCRM."

diff --git a/ang/crmUi.js b/ang/crmUi.js
index 216640ce90bb725636f70ea66b07fc7a80e97194..0b09c60de711e54d60d6e04d823878b09b16f6ae 100644 (file)
--- a/ang/crmUi.js
+++ b/ang/crmUi.js
@@ -1047,6 +1047,9 @@
 
     // Sets document title & page title; attempts to override CMS title markup for the latter
     // WARNING: Use only once per route!
+    // WARNING: This directive works only if your AngularJS base page does not
+    // set a custom title (i.e., it has an initial title of "CiviCRM"). See the
+    // global variables pageTitle and documentTitle.
     // Example (same title for both): <h1 crm-page-title>{{ts('Hello')}}</h1>
     // Example (separate document title): <h1 crm-document-title="ts('Hello')" crm-page-title><i class="crm-i fa-flag"></i>{{ts('Hello')}}</h1>
     .directive('crmPageTitle', function($timeout) {