From d2e5d2ce249a6f14c1bea3aef264eaf6285d553e Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Wed, 4 Feb 2015 11:22:47 +1300 Subject: [PATCH] INFRA-132 Function comment short description must end with a full stop regex (\*\*\n \* [A-Za-z ]*)\n replace with .\n --- CRM/ACL/API.php | 6 ++-- CRM/ACL/BAO/ACL.php | 8 ++--- CRM/ACL/BAO/EntityRole.php | 2 +- CRM/ACL/Form/ACL.php | 4 +-- CRM/ACL/Form/ACLBasic.php | 4 +-- CRM/ACL/Form/EntityRole.php | 4 +-- CRM/ACL/Form/WordPress/Permissions.php | 4 +-- CRM/ACL/Page/ACL.php | 12 +++---- CRM/ACL/Page/ACLBasic.php | 12 +++---- CRM/ACL/Page/EntityRole.php | 12 +++---- CRM/Case/BAO/Case.php | 34 +++++++++---------- CRM/Case/BAO/CaseType.php | 8 ++--- CRM/Case/Form/Activity.php | 14 ++++---- .../Form/Activity/ChangeCaseStartDate.php | 6 ++-- CRM/Case/Form/Activity/ChangeCaseStatus.php | 6 ++-- CRM/Case/Form/Activity/ChangeCaseType.php | 6 ++-- CRM/Core/BAO/CustomQuery.php | 26 +++++++------- 17 files changed, 84 insertions(+), 84 deletions(-) diff --git a/CRM/ACL/API.php b/CRM/ACL/API.php index 5bf1787529..9a2d11a244 100644 --- a/CRM/ACL/API.php +++ b/CRM/ACL/API.php @@ -35,7 +35,7 @@ class CRM_ACL_API { /** - * The various type of permissions + * The various type of permissions. * * @var int */ @@ -72,7 +72,7 @@ class CRM_ACL_API { } /** - * Get the permissioned where clause for the user + * Get the permissioned where clause for the user. * * @param int $type * The type of permission needed. @@ -143,7 +143,7 @@ class CRM_ACL_API { } /** - * Get all the groups the user has access to for the given operation + * Get all the groups the user has access to for the given operation. * * @param int $type * The type of permission needed. diff --git a/CRM/ACL/BAO/ACL.php b/CRM/ACL/BAO/ACL.php index 9e5e2fb9cc..2aacb1886c 100644 --- a/CRM/ACL/BAO/ACL.php +++ b/CRM/ACL/BAO/ACL.php @@ -446,7 +446,7 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { } /** - * Get all of the ACLs through ACL groups + * Get all of the ACLs through ACL groups. * * @param int $contact_id * ID of a contact to search for. @@ -512,7 +512,7 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { } /** - * Get all ACLs granted to a contact through all group memberships + * Get all ACLs granted to a contact through all group memberships. * * @param int $contact_id * The contact's ID. @@ -557,7 +557,7 @@ SELECT $acl.* } /** - * Get all of the ACLs for a contact through ACL groups owned by Contact + * Get all of the ACLs for a contact through ACL groups owned by Contact. * groups. * * @param int $contact_id @@ -963,7 +963,7 @@ ORDER BY a.object_id } /** - * Delete ACL records + * Delete ACL records. * * @param int $aclId * ID of the ACL record to be deleted. diff --git a/CRM/ACL/BAO/EntityRole.php b/CRM/ACL/BAO/EntityRole.php index 13935e81ef..0cc6e08d1e 100644 --- a/CRM/ACL/BAO/EntityRole.php +++ b/CRM/ACL/BAO/EntityRole.php @@ -88,7 +88,7 @@ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole { } /** - * Delete Entity Role records + * Delete Entity Role records. * * @param int $entityRoleId * ID of the EntityRole record to be deleted. diff --git a/CRM/ACL/Form/ACL.php b/CRM/ACL/Form/ACL.php index d904767aa5..0baa5b7cef 100644 --- a/CRM/ACL/Form/ACL.php +++ b/CRM/ACL/Form/ACL.php @@ -112,7 +112,7 @@ class CRM_ACL_Form_ACL extends CRM_Admin_Form { } /** - * Build the form object + * Build the form object. * * @return void */ @@ -265,7 +265,7 @@ class CRM_ACL_Form_ACL extends CRM_Admin_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/ACL/Form/ACLBasic.php b/CRM/ACL/Form/ACLBasic.php index f916fc3aa7..25e8fd71e2 100644 --- a/CRM/ACL/Form/ACLBasic.php +++ b/CRM/ACL/Form/ACLBasic.php @@ -74,7 +74,7 @@ SELECT object_table } /** - * Build the form object + * Build the form object. * * @return void */ @@ -123,7 +123,7 @@ SELECT object_table } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/ACL/Form/EntityRole.php b/CRM/ACL/Form/EntityRole.php index a7159cfb04..2d538a1a06 100644 --- a/CRM/ACL/Form/EntityRole.php +++ b/CRM/ACL/Form/EntityRole.php @@ -43,7 +43,7 @@ class CRM_ACL_Form_EntityRole extends CRM_Admin_Form { /** - * Build the form object + * Build the form object. * * @return void */ @@ -69,7 +69,7 @@ class CRM_ACL_Form_EntityRole extends CRM_Admin_Form { } /** - * Process the form submission + * Process the form submission. * * * @return void diff --git a/CRM/ACL/Form/WordPress/Permissions.php b/CRM/ACL/Form/WordPress/Permissions.php index d9937254aa..1523533f44 100644 --- a/CRM/ACL/Form/WordPress/Permissions.php +++ b/CRM/ACL/Form/WordPress/Permissions.php @@ -39,7 +39,7 @@ class CRM_ACL_Form_WordPress_Permissions extends CRM_Core_Form { /** - * Build the form object + * Build the form object. * * @return void */ @@ -98,7 +98,7 @@ class CRM_ACL_Form_WordPress_Permissions extends CRM_Core_Form { } /** - * Process the form submission + * Process the form submission. * * @return void */ diff --git a/CRM/ACL/Page/ACL.php b/CRM/ACL/Page/ACL.php index 69070d0d3e..df24276f58 100644 --- a/CRM/ACL/Page/ACL.php +++ b/CRM/ACL/Page/ACL.php @@ -45,14 +45,14 @@ class CRM_ACL_Page_ACL extends CRM_Core_Page_Basic { public $useLivePageJS = TRUE; /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -62,7 +62,7 @@ class CRM_ACL_Page_ACL extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -153,7 +153,7 @@ class CRM_ACL_Page_ACL extends CRM_Core_Page_Basic { } /** - * Browse all acls + * Browse all acls. * * @return void */ @@ -254,7 +254,7 @@ ORDER BY entity_id } /** - * Get name of edit form + * Get name of edit form. * * @return string * Classname of edit form. @@ -264,7 +264,7 @@ ORDER BY entity_id } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. diff --git a/CRM/ACL/Page/ACLBasic.php b/CRM/ACL/Page/ACLBasic.php index aef3c1a849..1254298475 100644 --- a/CRM/ACL/Page/ACLBasic.php +++ b/CRM/ACL/Page/ACLBasic.php @@ -43,14 +43,14 @@ class CRM_ACL_Page_ACLBasic extends CRM_Core_Page_Basic { /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -60,7 +60,7 @@ class CRM_ACL_Page_ACLBasic extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -129,7 +129,7 @@ class CRM_ACL_Page_ACLBasic extends CRM_Core_Page_Basic { } /** - * Browse all acls + * Browse all acls. * * @return void */ @@ -188,7 +188,7 @@ ORDER BY entity_id } /** - * Get name of edit form + * Get name of edit form. * * @return string * Classname of edit form. @@ -198,7 +198,7 @@ ORDER BY entity_id } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. diff --git a/CRM/ACL/Page/EntityRole.php b/CRM/ACL/Page/EntityRole.php index 4712453a67..ebd90fe361 100644 --- a/CRM/ACL/Page/EntityRole.php +++ b/CRM/ACL/Page/EntityRole.php @@ -45,14 +45,14 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic { public $useLivePageJS = TRUE; /** - * The action links that we need to display for the browse screen + * The action links that we need to display for the browse screen. * * @var array */ static $_links = NULL; /** - * Get BAO Name + * Get BAO Name. * * @return string * Classname of BAO. @@ -62,7 +62,7 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic { } /** - * Get action Links + * Get action Links. * * @return array * (reference) of action links @@ -150,7 +150,7 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic { } /** - * Browse all acls + * Browse all acls. * * @return void */ @@ -195,7 +195,7 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic { } /** - * Get name of edit form + * Get name of edit form. * * @return string * Classname of edit form. @@ -205,7 +205,7 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic { } /** - * Get edit form name + * Get edit form name. * * @return string * name of this page. diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index 6c6601bbd9..c15991849c 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -325,7 +325,7 @@ WHERE civicrm_case.id = %1"; } /** - * Delete the record that are associated with this case + * Delete the record that are associated with this case. * record are deleted from case * * @param int $caseId @@ -468,7 +468,7 @@ WHERE civicrm_case.id = %1"; } /** - * Retrieve contact names by caseId + * Retrieve contact names by caseId. * * @param int $caseId * ID of the case. @@ -959,7 +959,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Get Case roles + * Get Case roles. * * @param int $contactID * Contact id. @@ -1017,7 +1017,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Get Case Activities + * Get Case Activities. * * @param int $caseID * Case id. @@ -1363,7 +1363,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Get Case Related Contacts + * Get Case Related Contacts. * * @param int $caseID * Case id. @@ -1586,7 +1586,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Create an activity for a case via email + * Create an activity for a case via email. * * @param int $file * Email sent. @@ -1676,7 +1676,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Retrieve the scheduled activity type and date + * Retrieve the scheduled activity type and date. * * @param array $cases * Array of contact and case id. @@ -1720,7 +1720,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Combine all the exportable fields from the lower levels object + * Combine all the exportable fields from the lower levels object. * * @return array * array of exportable Fields @@ -1748,7 +1748,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Restore the record that are associated with this case + * Restore the record that are associated with this case. * * @param int $caseId * Id of the case to restore. @@ -1818,7 +1818,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c } /** - * Convenience function to get both case contacts and global in one array + * Convenience function to get both case contacts and global in one array. * @param int $caseId * * @return array @@ -3068,7 +3068,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * Verify user has permission to access a case + * Verify user has permission to access a case. * * @param int $caseId * @param bool $denyClosed @@ -3117,7 +3117,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * Check whether activity is a case Activity + * Check whether activity is a case Activity. * * @param int $activityID * Activity id. @@ -3138,7 +3138,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * Get all the case type ids currently in use + * Get all the case type ids currently in use. * * @return array */ @@ -3162,7 +3162,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * Get all the case status ids currently in use + * Get all the case status ids currently in use. * * @return array */ @@ -3183,7 +3183,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * Get all the encounter medium ids currently in use + * Get all the encounter medium ids currently in use. * * @return array */ @@ -3254,7 +3254,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * Used during case component enablement and during ugprade + * Used during case component enablement and during ugprade. * * @return bool */ @@ -3365,7 +3365,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; } /** - * Get the list of clients for a case + * Get the list of clients for a case. * * @param int $caseId * diff --git a/CRM/Case/BAO/CaseType.php b/CRM/Case/BAO/CaseType.php index f8f601f36b..e6c9e67537 100644 --- a/CRM/Case/BAO/CaseType.php +++ b/CRM/Case/BAO/CaseType.php @@ -40,14 +40,14 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { /** - * Static field for all the case information that we can potentially export + * Static field for all the case information that we can potentially export. * * @var array */ static $_exportableFields = NULL; /** - * Takes an associative array and creates a Case Type object + * Takes an associative array and creates a Case Type object. * * the function extract all the params it needs to initialize the create a * case type object. the params array could contain additional unused name/value @@ -188,7 +188,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { } /** - * Get the case definition either from db or read from xml file + * Get the case definition either from db or read from xml file. * * @param SimpleXmlElement $xml * A single case-type record. @@ -272,7 +272,7 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { } /** - * Takes an associative array and creates a case type object + * Takes an associative array and creates a case type object. * * @param array $params * (reference ) an assoc array of name/value pairs. diff --git a/CRM/Case/Form/Activity.php b/CRM/Case/Form/Activity.php index 57cce896cf..ff5808732e 100644 --- a/CRM/Case/Form/Activity.php +++ b/CRM/Case/Form/Activity.php @@ -40,35 +40,35 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { /** - * The default variable defined + * The default variable defined. * * @var int */ public $_caseId; /** - * The default case type variable defined + * The default case type variable defined. * * @var int */ public $_caseType; /** - * The default values of an activity + * The default values of an activity. * * @var array */ public $_defaults = array(); /** - * The array of releted contact info + * The array of releted contact info. * * @var array */ public $_relatedContacts; /** - * Build the form object + * Build the form object. * * @return void */ @@ -351,7 +351,7 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { } /** - * Global form rule + * Global form rule. * * @param array $fields * The input form values. @@ -372,7 +372,7 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { } /** - * Process the form submission + * Process the form submission. * * * @param array $params diff --git a/CRM/Case/Form/Activity/ChangeCaseStartDate.php b/CRM/Case/Form/Activity/ChangeCaseStartDate.php index 5576aaf8eb..8ae0f8f647 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStartDate.php +++ b/CRM/Case/Form/Activity/ChangeCaseStartDate.php @@ -101,7 +101,7 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $values * Posted values of the form. @@ -117,7 +117,7 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { } /** - * Process the form submission + * Process the form submission. * * * @param CRM_Core_Form $form @@ -132,7 +132,7 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { } /** - * Process the form submission + * Process the form submission. * * * @param CRM_Core_Form $form diff --git a/CRM/Case/Form/Activity/ChangeCaseStatus.php b/CRM/Case/Form/Activity/ChangeCaseStatus.php index d8db4c8333..ff619610de 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStatus.php +++ b/CRM/Case/Form/Activity/ChangeCaseStatus.php @@ -101,7 +101,7 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $values * Posted values of the form. @@ -117,7 +117,7 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { } /** - * Process the form submission + * Process the form submission. * * * @param CRM_Core_Form $form @@ -130,7 +130,7 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { } /** - * Process the form submission + * Process the form submission. * * * @param CRM_Core_Form $form diff --git a/CRM/Case/Form/Activity/ChangeCaseType.php b/CRM/Case/Form/Activity/ChangeCaseType.php index b1f6289212..387efed81f 100644 --- a/CRM/Case/Form/Activity/ChangeCaseType.php +++ b/CRM/Case/Form/Activity/ChangeCaseType.php @@ -98,7 +98,7 @@ class CRM_Case_Form_Activity_ChangeCaseType { } /** - * Global validation rules for the form + * Global validation rules for the form. * * @param array $values * Posted values of the form. @@ -114,7 +114,7 @@ class CRM_Case_Form_Activity_ChangeCaseType { } /** - * Process the form submission + * Process the form submission. * * * @param CRM_Core_Form $form @@ -137,7 +137,7 @@ class CRM_Case_Form_Activity_ChangeCaseType { } /** - * Process the form submission + * Process the form submission. * * * @param CRM_Core_Form $form diff --git a/CRM/Core/BAO/CustomQuery.php b/CRM/Core/BAO/CustomQuery.php index 0e549c1d67..5253f96312 100644 --- a/CRM/Core/BAO/CustomQuery.php +++ b/CRM/Core/BAO/CustomQuery.php @@ -37,21 +37,21 @@ class CRM_Core_BAO_CustomQuery { const PREFIX = 'custom_value_'; /** - * The set of custom field ids + * The set of custom field ids. * * @var array */ protected $_ids; /** - * The select clause + * The select clause. * * @var array */ public $_select; /** - * The name of the elements that are in the select clause + * The name of the elements that are in the select clause. * used to extract the values * * @var array @@ -59,7 +59,7 @@ class CRM_Core_BAO_CustomQuery { public $_element; /** - * The tables involved in the query + * The tables involved in the query. * * @var array */ @@ -67,28 +67,28 @@ class CRM_Core_BAO_CustomQuery { public $_whereTables; /** - * The where clause + * The where clause. * * @var array */ public $_where; /** - * The english language version of the query + * The english language version of the query. * * @var array */ public $_qill; /** - * The cache to translate the option values into labels + * The cache to translate the option values into labels. * * @var array */ public $_options; /** - * The custom fields information + * The custom fields information. * * @var array */ @@ -104,7 +104,7 @@ class CRM_Core_BAO_CustomQuery { protected $_locationSpecificCustomFields; /** - * This stores custom data group types and tables that it extends + * This stores custom data group types and tables that it extends. * * @var array */ @@ -129,7 +129,7 @@ class CRM_Core_BAO_CustomQuery { ); /** - * Class constructor + * Class constructor. * * Takes in a set of custom field ids andsets up the data structures to * generate a query @@ -253,7 +253,7 @@ SELECT label, value } /** - * Generate the select clause and the associated tables + * Generate the select clause and the associated tables. * for the from clause * * @return void @@ -318,7 +318,7 @@ SELECT label, value } /** - * Generate the where clause and also the english language + * Generate the where clause and also the english language. * equivalent * * @return void @@ -548,7 +548,7 @@ SELECT label, value } /** - * Function that does the actual query generation + * Function that does the actual query generation. * basically ties all the above functions together * * @return array -- 2.25.1