Add api doc link
authorColeman Watts <coleman@civicrm.org>
Tue, 17 Nov 2015 15:46:15 +0000 (10:46 -0500)
committerColeman Watts <coleman@civicrm.org>
Tue, 17 Nov 2015 15:46:15 +0000 (10:46 -0500)
ang/crmUtil.js
js/crm.ajax.js

index b58a5c5ad8b839a985d8b414d026618cc62637fe..d480279068239cb384be3ad958fa48a798d7af24 100644 (file)
@@ -2,8 +2,8 @@
 (function (angular, $, _) {
   angular.module('crmUtil', []);
 
-  // usage:
-  //   crmApi('Entity', 'action', {...}).then(function(apiResult){...})
+  // Angular implementation of CRM.api3
+  // @link http://wiki.civicrm.org/confluence/display/CRMDOC/AJAX+Interface#AJAXInterface-CRM.api3
   //
   // Note: To mock API results in unit-tests, override crmApi.backend, e.g.
   //   var apiSpy = jasmine.createSpy('crmApi');
index 58a09a6efb4de6be1ca391707290bef8e0ccd6eb..94600ebbeee436c4bb4a59b3f1b0f6cc4590e09e 100644 (file)
@@ -55,6 +55,7 @@
 
   /**
    * AJAX api
+   * @link http://wiki.civicrm.org/confluence/display/CRMDOC/AJAX+Interface#AJAXInterface-CRM.api3
    */
   CRM.api3 = function(entity, action, params, status) {
     if (typeof(entity) === 'string') {