From d2aa76c9fdddf1543047a49df5f9c08e76e15c4b Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Tue, 17 Nov 2015 10:46:15 -0500 Subject: [PATCH] Add api doc link --- ang/crmUtil.js | 4 ++-- js/crm.ajax.js | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/ang/crmUtil.js b/ang/crmUtil.js index b58a5c5ad8..d480279068 100644 --- a/ang/crmUtil.js +++ b/ang/crmUtil.js @@ -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'); diff --git a/js/crm.ajax.js b/js/crm.ajax.js index 58a09a6efb..94600ebbee 100644 --- a/js/crm.ajax.js +++ b/js/crm.ajax.js @@ -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') { -- 2.25.1