Merge pull request #7604 from rohankatkar/17815
[civicrm-core.git] / ang / crmUtil.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');