ProPeace/de.forumzfd.twinglecampaign
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve documentation for functions

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

14
api/v3/TwingleEvent/Sync.php
View file

@ -58,13 +58,13 @@ function _civicrm_api3_twingle_event_Sync_spec(array &$spec) {
* _NOTE:_ Changes on TwingleEvents are not meant to get pushed to Twingle, so * _NOTE:_ Changes on TwingleEvents are not meant to get pushed to Twingle, so
* the synchronization takes place only one way * the synchronization takes place only one way
* *
* * If you pass an **id** or **event_id** parameter, only one event will be * * If you provide an **id** or **event_id** parameter, only one event will be
* synchronized. * synchronized.
* *
* * If you pass a **project_id** as parameter, all events of that project will * * If you provide a **project_id** as parameter, all events of that project will
* be synchronized. * be synchronized.
* *
* * If you pass no **id**, **event_id** or **project_id** parameter, all events * * If you provide no **id**, **event_id** or **project_id** parameter, all events
* will be synchronized. * will be synchronized.
* *
* @param array $params * @param array $params
@ -307,7 +307,7 @@ function civicrm_api3_twingle_event_Sync(array $params): array {
/** /**
* Instantiates a TwingleEvent * # Instantiates a TwingleEvent
* *
* @param $values * @param $values
* *
@ -333,7 +333,8 @@ function instantiateEvent($values): CRM_TwingleCampaign_BAO_TwingleEvent {
/** /**
* Update a TwingleEvent campaign locally * # Update TwingleEvent locally
* Updates a TwingleEvent campaign locally.
* *
* @param array $event_from_twingle * @param array $event_from_twingle
* @param \CRM_TwingleCampaign_BAO_TwingleEvent $event * @param \CRM_TwingleCampaign_BAO_TwingleEvent $event
@ -382,7 +383,8 @@ function updateLocally(array $event_from_twingle,
/** /**
* Synchronize a TwingleEvent campaign with an event from Twingle one way * ## Synchronize TwingleEvent
* Synchronizes a TwingleEvent campaign with an event from Twingle one way.
* *
* _NOTE:_ Changes on TwingleEvents are not meant to get pushed to Twingle, so * _NOTE:_ Changes on TwingleEvents are not meant to get pushed to Twingle, so
* the synchronization takes place only one way * the synchronization takes place only one way

7
api/v3/TwingleProject/Sync.php
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 * Synchronize one ore more campaigns of the type TwingleProject between CiviCRM
* and Twingle. * 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. * 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. * synchronized.
* *
* @param array $params * @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_TwingleProject $project
* @param \CRM_TwingleCampaign_BAO_TwingleApiCall $twingleApi * @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 * Synchronize a TwingleProject campaign with a project from Twingle
* *
* @param \CRM_TwingleCampaign_BAO_TwingleProject $project * @param \CRM_TwingleCampaign_BAO_TwingleProject $project