From 0c99d16115acdced65bc52274e4783347e5c724c Mon Sep 17 00:00:00 2001
From: Julio Cesar Laura <juliocesar@colosa.com>
Date: Wed, 3 Apr 2013 13:40:57 -0400
Subject: [PATCH] BUG 11074 Triggers wizard. Doble instruccion en campo del
 wizard SOLVED

- The comments don't include a description for the return value
- Add a empty description to avoid the innecesary label "Not required"
---
 .../triggers/class.pmAlfrescoFunctions.php    | 20 ++++++++--------
 .../triggers/class.pmSharepointFunctions.php  | 24 +++++++++----------
 .../triggers/class.pmSugarFunctions.php       | 22 ++++++++---------
 .../triggers/class.pmTalendFunctions.php      |  2 +-
 .../classes/triggers/class.pmTrZimbra.php     | 18 +++++++-------
 5 files changed, 43 insertions(+), 43 deletions(-)

diff --git a/workflow/engine/classes/triggers/class.pmAlfrescoFunctions.php b/workflow/engine/classes/triggers/class.pmAlfrescoFunctions.php
index 6659b9196..382578835 100755
--- a/workflow/engine/classes/triggers/class.pmAlfrescoFunctions.php
+++ b/workflow/engine/classes/triggers/class.pmAlfrescoFunctions.php
@@ -36,7 +36,7 @@
  * @param string | $user | Valid Admin username to connect to Alfresco server
  * @param string | $pwd | Valid Admin password to connect to Alfresco server
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 G::LoadSystem('restClient');
@@ -66,10 +66,10 @@ function cancelCheckout($alfrescoServerUrl, $docUid, $user = "", $pwd = "")
  * @param string | $user | Valid Admin username to connect to Alfresco server
  * @param string | $pwd | Valid Admin password to connect to Alfresco server
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
-// Validation done
+
 function checkIn($alfrescoServerUrl, $docUid, $comments, $user = "", $pwd = "")
 {
     $alfresco_url = "$alfrescoServerUrl/s/cmis/pwc/i/$docUid?checkin=true&checkinComment=$comments";
@@ -100,7 +100,7 @@ function checkIn($alfrescoServerUrl, $docUid, $comments, $user = "", $pwd = "")
  * @param string | $user | Valid Admin username to connect to Alfresco server
  * @param string | $pwd | Valid Admin password to connect to Alfresco server
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 // Validation done
@@ -135,7 +135,7 @@ function checkOut($alfrescoServerUrl, $docUid, $user = "", $pwd = "")
  * @param string | $user | Valid Admin username to connect to Alfresco server
  * @param string | $pwd | Valid Admin password to connect to Alfresco server
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function createFolder($alfrescoServerUrl, $parentFolder, $folderName, $user, $pwd)
@@ -174,7 +174,7 @@ function createFolder($alfrescoServerUrl, $parentFolder, $folderName, $user, $pw
  * @param string | $user | Valid Admin username to connect to Alfresco server
  * @param string | $pwd | Valid Admin password to connect to Alfresco server
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function deleteObject($alfrescoServerUrl, $objetcId, $user, $pwd)
@@ -202,7 +202,7 @@ function deleteObject($alfrescoServerUrl, $objetcId, $user, $pwd)
  * @param string | $pwd | Valid Admin password to connect to Alfresco server
  * @param string | $mainFolder | The main folder in alfreco to save the files
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function downloadDoc($alfrescoServerUrl, $pathFile, $pathFolder, $user, $pwd, $mainFolder = 'Sites')
@@ -255,7 +255,7 @@ function downloadDoc($alfrescoServerUrl, $pathFile, $pathFolder, $user, $pwd, $m
  * @param string | $user | Valid Admin username to connect to Alfresco server
  * @param string | $pwd | Valid Admin password to connect to Alfresco server
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function getCheckedoutFiles($alfrescoServerUrl, $user, $pwd)
@@ -284,7 +284,7 @@ function getCheckedoutFiles($alfrescoServerUrl, $user, $pwd)
  * @param string | $user | Valid Admin username to connect to Alfresco server
  * @param string | $pwd | Valid Admin password to connect to Alfresco server
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function getFolderChildren($alfrescoServerUrl, $folderId, $user, $pwd)
@@ -317,7 +317,7 @@ function getFolderChildren($alfrescoServerUrl, $folderId, $user, $pwd)
  * @param string | $path | Path of document to be Uploaded
  * @param string | $mainFolder | The main folder in alfreco to save the files
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function uploadDoc($alfrescoServerUrl, $fileSource, $title, $description, $docType, $user, $pwd, $path = '', $mainFolder= 'Sites')
diff --git a/workflow/engine/classes/triggers/class.pmSharepointFunctions.php b/workflow/engine/classes/triggers/class.pmSharepointFunctions.php
index a1c5899e1..307520fcb 100755
--- a/workflow/engine/classes/triggers/class.pmSharepointFunctions.php
+++ b/workflow/engine/classes/triggers/class.pmSharepointFunctions.php
@@ -41,7 +41,7 @@
  * @param string | $title | Title of DWS
  * @param string | $documents | Document that need to be attached to DWS
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function createDWS ($sharepointServer, $auth, $name = "", $users = "", $title = "", $documents = "", $result = "")
@@ -66,7 +66,7 @@ function createDWS ($sharepointServer, $auth, $name = "", $users = "", $title =
  * @param string | $auth | Valid Auth string to connect to server | user:password
  * @param string | $dwsname | Name of DWS to be deleted
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function deleteDWS ($sharepointServer, $auth, $dwsname)
@@ -97,7 +97,7 @@ function deleteDWS ($sharepointServer, $auth, $dwsname)
  * @param string | $dwsname | Name of DWS
  * @param string | $dwsFolderName | Name of DWS folder
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function createFolderDWS ($sharepointServer, $auth, $dwsname, $dwsFolderName)
@@ -131,7 +131,7 @@ function createFolderDWS ($sharepointServer, $auth, $dwsname, $dwsFolderName)
  * @param string | $dwsname | Name of DWS
  * @param string | $delDwsFolderName | Name of DWS folder to be deleted
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 
@@ -165,7 +165,7 @@ function deleteFolderDWS ($sharepointServer, $auth, $dwsname, $folderName)
  * @param string | $dwsname | Name of DWS
  * @param string | $lastUpdate | LastUpdate
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function getDWSData ($sharepointServer, $auth, $newFileName, $dwsname, $lastUpdate)
@@ -196,7 +196,7 @@ function getDWSData ($sharepointServer, $auth, $newFileName, $dwsname, $lastUpda
  * @param string | $id | ID
  *
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function getDWSMetaData ($sharepointServer, $auth, $newFileName, $dwsname, $id)
@@ -229,7 +229,7 @@ function getDWSMetaData ($sharepointServer, $auth, $newFileName, $dwsname, $id)
  * @param string | $sourceUrl | Absolute path of the file to upload
  * @param string | $filename | Name of the File to Upload
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function uploadDocumentDWS ($sharepointServer, $auth, $dwsname, $folderName, $sourceUrl, $filename)
@@ -256,7 +256,7 @@ function uploadDocumentDWS ($sharepointServer, $auth, $dwsname, $folderName, $so
  * @param string | $fileName | File to be downloaded
  * @param string | $fileLocation | Location to be downloaded into
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function downloadDocumentDWS ($sharepointServer, $auth, $dwsname, $fileName, $fileLocation)
@@ -285,7 +285,7 @@ function downloadDocumentDWS ($sharepointServer, $auth, $dwsname, $fileName, $fi
  * @param string | $dwsname | Name of the DWS
  * @param string | $strFolderUrl | Folder URL
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function getDWSFolderItems ($sharepointServer, $auth, $dwsname, $strFolderUrl)
@@ -314,7 +314,7 @@ function getDWSFolderItems ($sharepointServer, $auth, $dwsname, $strFolderUrl)
  * @param string | $newFileName | Name of New File
  * @param string | $dwsname | Name of DWS
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function getDWSDocumentVersions ($sharepointServer, $auth, $newFileName, $dwsname)
@@ -355,7 +355,7 @@ function getDWSDocumentVersions ($sharepointServer, $auth, $newFileName, $dwsnam
  * @param string | $dwsname | Name of DWS
  * @param string | $versionNum | Version No.
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function deleteDWSDocumentVersion ($sharepointServer, $auth, $newFileName, $dwsname, $versionNum)
@@ -380,7 +380,7 @@ function deleteDWSDocumentVersion ($sharepointServer, $auth, $newFileName, $dwsn
  * @param string | $newFileName | Name of File
  * @param string | $dwsname | Name of DWS
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function deleteDWSAllDocumentVersion ($sharepointServer, $auth, $newFileName, $dwsname)
diff --git a/workflow/engine/classes/triggers/class.pmSugarFunctions.php b/workflow/engine/classes/triggers/class.pmSugarFunctions.php
index ffa30a7e6..02f1ee999 100755
--- a/workflow/engine/classes/triggers/class.pmSugarFunctions.php
+++ b/workflow/engine/classes/triggers/class.pmSugarFunctions.php
@@ -87,7 +87,7 @@ function objectToArray ($object)
  * @param string | $linkNameToFieldsArray | A list of link names and the fields to be returned for each link name.
  * @param string | $resultType=array | Result type (array or object)
  *
- * @return array/object | $sugarEntries | Sugar Entries (array or object)
+ * @return array/object | $sugarEntries | Sugar Entries (array or object) |
  *
  */
 
@@ -124,7 +124,7 @@ function GetSugarEntry ($sugarSoap, $user, $password, $module, $id, $selectField
  * @param string | $maxResults=50 | Max Results
  * @param string | $resultType=array | Result type (array or object)
  *
- * @return array/object | $sugarEntries | Sugar Entries (array or object)
+ * @return array/object | $sugarEntries | Sugar Entries (array or object) |
  *
  */
 
@@ -168,7 +168,7 @@ function GetSugarEntries ($sugarSoap, $user, $password, $module, $query, $orderB
  * @param string | $maxResults=50 | Max Results
  * @param string | $resultType=array | Result type (array or object)
  *
- * @return array/object | $sugarCalls | Sugar Calls (array or object)
+ * @return array/object | $sugarCalls | Sugar Calls (array or object) |
  *
  */
 
@@ -196,7 +196,7 @@ function GetSugarCalls ($sugarSoap, $user, $password, $query, $orderBy, $selecte
  * @param string | $maxResults=50 | Max Results
  * @param string | $resultType=array | Result type (array or object)
  *
- * @return array/object | $sugarLeads | Sugar Leads (array or object)
+ * @return array/object | $sugarLeads | Sugar Leads (array or object) |
  *
  */
 
@@ -224,7 +224,7 @@ function GetSugarLeads ($sugarSoap, $user, $password, $query, $orderBy, $selecte
  * @param string | $maxResults=50 | Max Results
  * @param string | $resultType=array | Result type (array or object)
  *
- * @return array/object | $sugarContacts | Sugar Contacts (array or object)
+ * @return array/object | $sugarContacts | Sugar Contacts (array or object) |
  *
  */
 
@@ -252,7 +252,7 @@ function GetSugarContacts ($sugarSoap, $user, $password, $query, $orderBy, $sele
  * @param string | $maxResults=50 | Max Results
  * @param string | $resultType=array | Result type (array or object)
  *
- * @return array/object | $sugarAccount | Sugar Opportunities (array or object)
+ * @return array/object | $sugarAccount | Sugar Opportunities (array or object) |
  *
  */
 
@@ -280,7 +280,7 @@ function GetSugarOpportunities ($sugarSoap, $user, $password, $query, $orderBy,
  * @param string | $maxResults=50 | Max Results
  * @param string | $resultType=array | Result type (array or object)
  *
- * @return array/object | $sugarAccount | Sugar Opportunities (array or object)
+ * @return array/object | $sugarAccount | Sugar Opportunities (array or object) |
  *
  */
 
@@ -306,7 +306,7 @@ function GetSugarAccount ($sugarSoap, $user, $password, $query, $orderBy, $selec
  * @param string | $name | Account name
  * @param string | $resultType=array | Result type (array or object)
  *
- * @return array/object | $sugarAccount | Sugar Opportunities (array or object)
+ * @return array/object | $sugarAccount | Sugar Opportunities (array or object) |
  *
  */
 function CreateSugarAccount ($sugarSoap, $user, $password, $name, $resultType = "array")
@@ -354,7 +354,7 @@ function CreateSugarAccount ($sugarSoap, $user, $password, $name, $resultType =
  * @param string | $account_id | Valid id account
  * @param string | $resultType=array | Result type (array or object)
  *
- * @return array/object | $sugarContact | Sugar Opportunities (array or object)
+ * @return array/object | $sugarContact | Sugar Opportunities (array or object) |
  *
  */
 function CreateSugarContact ($sugarSoap, $user, $password, $first_name, $last_name, $email, $title, $phone, $account_id, $resultType = "array")
@@ -414,7 +414,7 @@ function CreateSugarContact ($sugarSoap, $user, $password, $first_name, $last_na
  * @param string | $sales_stage | Prospecting, Qualification, Needs Analysis, Value Proposition, Id. Decision Makers, Perception Analysis, Proposal/Price Quote, Negotiation/Review, Closed Won, Closed Lost
  * @param string | $resultType=array | Result type (array or object)
  *
- * @return array/object | $sugarOpportunity | Sugar Opportunities (array or object)
+ * @return array/object | $sugarOpportunity | Sugar Opportunities (array or object) |
  *
  */
 function CreateSugarOpportunity ($sugarSoap, $user, $password, $name, $account_id, $amount, $date_closed, $sales_stage, $resultType = "array")
@@ -479,7 +479,7 @@ function CreateSugarOpportunity ($sugarSoap, $user, $password, $name, $account_i
  * @param string | $account_id | Valid id account
  * @param string | $resultType=array | Result type (array or object)
  *
- * @return array/object | $sugarContact | Sugar Opportunities (array or object)
+ * @return array/object | $sugarContact | Sugar Opportunities (array or object) |
  *
  */
 function CreateSugarLeads ($sugarSoap, $user, $password, $first_name, $last_name, $email, $title, $phone, $account_id, $resultType = "array")
diff --git a/workflow/engine/classes/triggers/class.pmTalendFunctions.php b/workflow/engine/classes/triggers/class.pmTalendFunctions.php
index edbb13644..138496ca6 100755
--- a/workflow/engine/classes/triggers/class.pmTalendFunctions.php
+++ b/workflow/engine/classes/triggers/class.pmTalendFunctions.php
@@ -36,7 +36,7 @@
  * @param string | $wsdl | Talend Web Service (including ?WSDL)
  * @param array(array(n1 v1) array(n2 v2) array(nN vN)) | $params | Array of params. Pairs of param Name Value
  * @param string | $message | Message to be displayed
- * @return array | $return | Talend Array
+ * @return array | $return | Talend Array |
  *
  */
 function executeTalendWebservice ($wsdl, $message, $params = array())
diff --git a/workflow/engine/classes/triggers/class.pmTrZimbra.php b/workflow/engine/classes/triggers/class.pmTrZimbra.php
index 304ff6d71..309b24a26 100644
--- a/workflow/engine/classes/triggers/class.pmTrZimbra.php
+++ b/workflow/engine/classes/triggers/class.pmTrZimbra.php
@@ -37,7 +37,7 @@
  * @param string | $folderName | Folder Name
  * @param string | $protocol | protpcol server http https
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 include_once PATH_CORE . 'classes' . PATH_SEP . 'triggers' . PATH_SEP . 'api' . PATH_SEP . "class.zimbraApi.php";
@@ -72,7 +72,7 @@ function getZimbraFolder($ServerUrl, $username, $preAuthKey, $folderName, $proto
  * @param string | $preAuthKey | Server Key for SSO authentication
  * @param string | $protocol | protpcol server http https
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function getZimbraContactList($ServerUrl, $username, $preAuthKey, $protocol = 'http')
@@ -106,7 +106,7 @@ function getZimbraContactList($ServerUrl, $username, $preAuthKey, $protocol = 'h
  * @param string | $preAuthKey | Server Key for SSO authentication
  * @param string | $protocol | protpcol server http https
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function getZimbraTaskList($ServerUrl, $username, $preAuthKey, $protocol = 'http')
@@ -143,7 +143,7 @@ function getZimbraTaskList($ServerUrl, $username, $preAuthKey, $protocol = 'http
  * @param string | $preAuthKey | Server Key for SSO authentication
  * @param string | $protocol | protpcol server http https
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function getZimbraAppointmentList($ServerUrl, $username, $preAuthKey, $protocol = 'http')
@@ -182,7 +182,7 @@ function getZimbraAppointmentList($ServerUrl, $username, $preAuthKey, $protocol
  * @param string | $color | Color of Folder
  * @param string | $protocol | protpcol server http https
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function createZimbraFolder($ServerUrl, $username, $preAuthKey, $folderName, $color, $protocol = 'http')
@@ -223,7 +223,7 @@ function createZimbraFolder($ServerUrl, $username, $preAuthKey, $folderName, $co
  * @param string | $otherDataValue | Corresponding Date or Value
  * @param string | $protocol | protpcol server http https
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function createZimbraContacts($ServerUrl, $username, $preAuthKey, $firstName, $lastName, $email, $otherData, $otherDataValue, $protocol = 'http')
@@ -272,7 +272,7 @@ function createZimbraContacts($ServerUrl, $username, $preAuthKey, $firstName, $l
  * @param string | $percent | Percentage of Task Completed
  * @param string | $protocol | protpcol server http https
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function createZimbraTask($ServerUrl, $username, $preAuthKey, $subject, $taskName, $friendlyName, $userEmail, $priority, $allDay, $class, $location, $dueDate, $status, $percent, $protocol = 'http')
@@ -326,7 +326,7 @@ function createZimbraTask($ServerUrl, $username, $preAuthKey, $subject, $taskNam
  * @param string | $tz | Time Zone
  * @param string | $protocol | protpcol server http https
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function createZimbraAppointment($ServerUrl, $username, $preAuthKey, $subject, $appointmentName, $friendlyName, $userEmail, $domainName, $schedule, $cutype, $allDay, $isOrg, $rsvp, $atFriendlyName, $role, $location, $ptst, $startDate, $endDate, $tz = '', $protocol = 'http')
@@ -366,7 +366,7 @@ function createZimbraAppointment($ServerUrl, $username, $preAuthKey, $subject, $
  * @param string | $fileLocation | Absolute path of the File to be uploaded.
  * @param string | $protocol | protpcol server http https
  *
- * @return string | $result | Response
+ * @return string | $result | Response |
  *
  */
 function uploadZimbraFile($ServerUrl, $username, $preAuthKey, $folderName, $fileLocation, $protocol = 'http')