Update code comments
authorColeman Watts <coleman@civicrm.org>
Mon, 29 Apr 2013 01:14:20 +0000 (18:14 -0700)
committerColeman Watts <coleman@civicrm.org>
Mon, 29 Apr 2013 01:14:20 +0000 (18:14 -0700)
CRM/Core/Resources.php

index 66e94d2b067360f0063a65bb8d9066acdc595e25..8fa14b22cf7fa5af9f53808a5eb502446bee264c 100644 (file)
@@ -195,6 +195,14 @@ class CRM_Core_Resources {
   /**
    * Add JavaScript variables to the global CRM object.
    *
+   * Example:
+   * From the server:
+   * CRM_Core_Resources::singleton()->addSetting(array('myNamespace' => array('foo' => 'bar')));
+   * From javascript:
+   * CRM.myNamespace.foo // "bar"
+   *
+   * @see http://wiki.civicrm.org/confluence/display/CRMDOC43/Javascript+Reference
+   *
    * @param $settings array
    * @return CRM_Core_Resources
    */
@@ -253,12 +261,6 @@ class CRM_Core_Resources {
    * Helper fn for addSetting
    * Render JavaScript variables for the global CRM object.
    *
-   * Example:
-   * From the server:
-   * CRM_Core_Resources::singleton()->addSetting(array('myNamespace' => array('foo' => 'bar')));
-   * From javascript:
-   * CRM.myNamespace.foo // "bar"
-   *
    * @return string
    */
   public function renderSetting() {