improve documentation for functions

This commit is contained in:
Marc Michalsky forumZFD 2021-02-01 15:05:22 +01:00
parent 4664638299
commit f7087affd8
Signed by untrusted user who does not match committer: marc.koch
GPG key ID: 12406554CFB028B9
2 changed files with 12 additions and 9 deletions

View file

@ -51,10 +51,10 @@ function _civicrm_api3_twingle_project_Sync_spec(array &$spec) {
* Synchronize one ore more campaigns of the type TwingleProject between CiviCRM
* and Twingle.
*
* * If you pass an **id** or **project_id** parameter, *only one project* will
* * If you provide an **id** or **project_id** parameter, *only one project* will
* be synchronized.
*
* * If you pass no **id** or **project_id** parameter, *all projects* will be
* * If you provide no **id** or **project_id** parameter, *all projects* will be
* synchronized.
*
* @param array $params
@ -322,7 +322,7 @@ function updateLocally(array $project_from_twingle,
/**
* Push a TwingleProject via API to Twingle
* ## Push a TwingleProject to Twingle
*
* @param \CRM_TwingleCampaign_BAO_TwingleProject $project
* @param \CRM_TwingleCampaign_BAO_TwingleApiCall $twingleApi
@ -407,6 +407,7 @@ function pushToTwingle(TwingleProject $project,
/**
* ## Synchronize TwingleProject
* Synchronize a TwingleProject campaign with a project from Twingle
*
* @param \CRM_TwingleCampaign_BAO_TwingleProject $project