From: Coleman Watts <coleman@civicrm.org>
Date: Sat, 10 Jan 2015 03:03:14 +0000 (-0500)
Subject: INFRA-132 - Whitespace fixes in docbloks
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=d60f50a83c989d89d950d54ad2d91411466cf0dc;p=civicrm-core.git

INFRA-132 - Whitespace fixes in docbloks
---

diff --git a/CRM/Activity/BAO/ICalendar.php b/CRM/Activity/BAO/ICalendar.php
index 671bd64d98..d81317c027 100644
--- a/CRM/Activity/BAO/ICalendar.php
+++ b/CRM/Activity/BAO/ICalendar.php
@@ -51,7 +51,7 @@ class CRM_Activity_BAO_ICalendar {
    *   Reference to an activity object.
    *
    * @return \CRM_Activity_BAO_ICalendar
-  @access public
+   * @access public
    */
   public function __construct(&$act) {
     $this->activity = $act;
@@ -65,8 +65,8 @@ class CRM_Activity_BAO_ICalendar {
    * @param array $contacts
    *   Array of contacts (attendees).
    *
-   * @return string
-   *   Array index of the added attachment in the $attachments array, or else NULL.
+   * @return string|null
+   *   Array index of the added attachment in the $attachments array, else NULL.
    */
   public function addAttachment(&$attachments, $contacts) {
     // Check preferences setting
@@ -105,14 +105,17 @@ class CRM_Activity_BAO_ICalendar {
     return NULL;
   }
 
+  /**
+   * Remove temp file
+   */
   public function cleanup() {
     if (!empty ($this->icsfile)) {
       @unlink($this->icsfile);
     }
   }
 
-  // TODO: Is there a better way to do this?
   /**
+   * TODO: Is there a better way to do this?
    * @return string
    */
   private function getPrimaryEmail() {
diff --git a/CRM/Activity/Selector/Activity.php b/CRM/Activity/Selector/Activity.php
index ddad477fa0..ebcccca104 100644
--- a/CRM/Activity/Selector/Activity.php
+++ b/CRM/Activity/Selector/Activity.php
@@ -75,7 +75,7 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C
    * @param null $activityTypeIDs
    *
    * @return \CRM_Activity_Selector_Activity
-  @access public
+   * @access public
    */
   function __construct(
     $contactId,
diff --git a/CRM/Activity/Selector/Search.php b/CRM/Activity/Selector/Search.php
index 2fb16fd79b..1cc43cf9a8 100644
--- a/CRM/Activity/Selector/Search.php
+++ b/CRM/Activity/Selector/Search.php
@@ -155,7 +155,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM
    * @param null $compContext
    *
    * @return \CRM_Activity_Selector_Search
-  @access public
+   * @access public
    */
   function __construct(
     &$queryParams,
diff --git a/CRM/Campaign/BAO/Petition.php b/CRM/Campaign/BAO/Petition.php
index 637f07e69c..23072c0725 100644
--- a/CRM/Campaign/BAO/Petition.php
+++ b/CRM/Campaign/BAO/Petition.php
@@ -543,7 +543,7 @@ AND         tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )";
    *
    * @throws Exception
    * @return void
-  @access public
+   * @access public
    * @static
    */
   public static function sendEmail($params, $sendEmailMode) {
diff --git a/CRM/Campaign/Selector/Search.php b/CRM/Campaign/Selector/Search.php
index 7806b61269..90d2be1a63 100755
--- a/CRM/Campaign/Selector/Search.php
+++ b/CRM/Campaign/Selector/Search.php
@@ -147,7 +147,7 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM
    * @param string $context
    *
    * @return \CRM_Campaign_Selector_Search
-  @access public
+   * @access public
    */
   function __construct(
     &$queryParams,
diff --git a/CRM/Case/Selector/Search.php b/CRM/Case/Selector/Search.php
index e0550729aa..0886e09556 100644
--- a/CRM/Case/Selector/Search.php
+++ b/CRM/Case/Selector/Search.php
@@ -143,7 +143,7 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base {
    * @param string $context
    *
    * @return \CRM_Case_Selector_Search
-  @access public
+   * @access public
    */
   function __construct(
     &$queryParams,
diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php
index c5a9cb07fc..8933683827 100644
--- a/CRM/Contact/BAO/Query.php
+++ b/CRM/Contact/BAO/Query.php
@@ -416,7 +416,7 @@ class CRM_Contact_BAO_Query {
    * @param string $operator
    *
    * @return \CRM_Contact_BAO_Query
-  @access public
+   * @access public
    */
   function __construct(
     $params = NULL, $returnProperties = NULL, $fields = NULL,
diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php
index f9b3099efc..3feadfd493 100644
--- a/CRM/Contact/BAO/Relationship.php
+++ b/CRM/Contact/BAO/Relationship.php
@@ -722,7 +722,7 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship {
    *   This is contact id for adding relationship.
    *
    * @return string
-  @access public
+   * @access public
    * @static
    */
   public static function checkValidRelationship($params, $ids, $contactId) {
diff --git a/CRM/Contact/Selector/Custom.php b/CRM/Contact/Selector/Custom.php
index c8acb4d0df..e8dee4b0a8 100644
--- a/CRM/Contact/Selector/Custom.php
+++ b/CRM/Contact/Selector/Custom.php
@@ -119,7 +119,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
    * @param null $contextMenu
    *
    * @return \CRM_Contact_Selector_Custom
-  @access public
+   * @access public
    */
   function __construct(
     $customSearchClass,
diff --git a/CRM/Contribute/Selector/Search.php b/CRM/Contribute/Selector/Search.php
index 8a3f10c72f..aed61ada1c 100644
--- a/CRM/Contribute/Selector/Search.php
+++ b/CRM/Contribute/Selector/Search.php
@@ -165,7 +165,7 @@ class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements C
    * @param null $compContext
    *
    * @return \CRM_Contribute_Selector_Search
-  @access public
+   * @access public
    */
   function __construct(
     &$queryParams,
diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php
index 18a4cffd5a..eb8c70d806 100644
--- a/CRM/Core/DAO.php
+++ b/CRM/Core/DAO.php
@@ -80,7 +80,7 @@ class CRM_Core_DAO extends DB_DataObject {
    * Class constructor
    *
    * @return \CRM_Core_DAO
-  @access public
+   * @access public
    */
   public function __construct() {
     $this->initialize();
diff --git a/CRM/Core/QuickForm/Action.php b/CRM/Core/QuickForm/Action.php
index 36a65562ca..7aecbd07b4 100644
--- a/CRM/Core/QuickForm/Action.php
+++ b/CRM/Core/QuickForm/Action.php
@@ -54,7 +54,7 @@ class CRM_Core_QuickForm_Action extends HTML_QuickForm_Action {
    *   Reference to state machine object.
    *
    * @return \CRM_Core_QuickForm_Action
-  @access public
+   * @access public
    */
   public function __construct(&$stateMachine) {
     $this->_stateMachine = &$stateMachine;
diff --git a/CRM/Core/QuickForm/Action/Cancel.php b/CRM/Core/QuickForm/Action/Cancel.php
index 198e0d1b7c..5d548aa532 100644
--- a/CRM/Core/QuickForm/Action/Cancel.php
+++ b/CRM/Core/QuickForm/Action/Cancel.php
@@ -42,7 +42,7 @@ class CRM_Core_QuickForm_Action_Cancel extends CRM_Core_QuickForm_Action {
    *   Reference to state machine object.
    *
    * @return \CRM_Core_QuickForm_Action_Cancel
-  @access public
+   * @access public
    */
   public function __construct(&$stateMachine) {
     parent::__construct($stateMachine);
diff --git a/CRM/Core/QuickForm/Action/Display.php b/CRM/Core/QuickForm/Action/Display.php
index c92139478b..54a127d1b8 100644
--- a/CRM/Core/QuickForm/Action/Display.php
+++ b/CRM/Core/QuickForm/Action/Display.php
@@ -54,7 +54,7 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action {
    *   Reference to state machine object.
    *
    * @return \CRM_Core_QuickForm_Action_Display
-  @access public
+   * @access public
    */
   public function __construct(&$stateMachine) {
     parent::__construct($stateMachine);
diff --git a/CRM/Core/QuickForm/Action/Done.php b/CRM/Core/QuickForm/Action/Done.php
index e1fbff4309..88cc21d7b9 100644
--- a/CRM/Core/QuickForm/Action/Done.php
+++ b/CRM/Core/QuickForm/Action/Done.php
@@ -42,7 +42,7 @@ class CRM_Core_QuickForm_Action_Done extends CRM_Core_QuickForm_Action {
    *   Reference to state machine object.
    *
    * @return \CRM_Core_QuickForm_Action_Done
-  @access public
+   * @access public
    */
   public function __construct(&$stateMachine) {
     parent::__construct($stateMachine);
diff --git a/CRM/Core/QuickForm/Action/Jump.php b/CRM/Core/QuickForm/Action/Jump.php
index 52ff324167..d77008b065 100644
--- a/CRM/Core/QuickForm/Action/Jump.php
+++ b/CRM/Core/QuickForm/Action/Jump.php
@@ -42,7 +42,7 @@ class CRM_Core_QuickForm_Action_Jump extends CRM_Core_QuickForm_Action {
    *   Reference to state machine object.
    *
    * @return \CRM_Core_QuickForm_Action_Jump
-  @access public
+   * @access public
    */
   public function __construct(&$stateMachine) {
     parent::__construct($stateMachine);
diff --git a/CRM/Core/QuickForm/Action/Next.php b/CRM/Core/QuickForm/Action/Next.php
index 8df1e00bf8..6ad9ecce61 100644
--- a/CRM/Core/QuickForm/Action/Next.php
+++ b/CRM/Core/QuickForm/Action/Next.php
@@ -42,7 +42,7 @@ class CRM_Core_QuickForm_Action_Next extends CRM_Core_QuickForm_Action {
    *   Reference to state machine object.
    *
    * @return \CRM_Core_QuickForm_Action_Next
-  @access public
+   * @access public
    */
   public function __construct(&$stateMachine) {
     parent::__construct($stateMachine);
diff --git a/CRM/Core/QuickForm/Action/Process.php b/CRM/Core/QuickForm/Action/Process.php
index eb47b050b5..f65b18b706 100644
--- a/CRM/Core/QuickForm/Action/Process.php
+++ b/CRM/Core/QuickForm/Action/Process.php
@@ -42,7 +42,7 @@ class CRM_Core_QuickForm_Action_Process extends CRM_Core_QuickForm_Action {
    *   Reference to state machine object.
    *
    * @return \CRM_Core_QuickForm_Action_Process
-  @access public
+   * @access public
    */
   public function __construct(&$stateMachine) {
     parent::__construct($stateMachine);
diff --git a/CRM/Core/QuickForm/Action/Refresh.php b/CRM/Core/QuickForm/Action/Refresh.php
index f5efbc4d8e..9990687560 100644
--- a/CRM/Core/QuickForm/Action/Refresh.php
+++ b/CRM/Core/QuickForm/Action/Refresh.php
@@ -42,7 +42,7 @@ class CRM_Core_QuickForm_Action_Refresh extends CRM_Core_QuickForm_Action {
    *   Reference to state machine object.
    *
    * @return \CRM_Core_QuickForm_Action_Refresh
-  @access public
+   * @access public
    */
   public function __construct(&$stateMachine) {
     parent::__construct($stateMachine);
diff --git a/CRM/Core/QuickForm/Action/Reload.php b/CRM/Core/QuickForm/Action/Reload.php
index 69d5fc36d4..439665363a 100644
--- a/CRM/Core/QuickForm/Action/Reload.php
+++ b/CRM/Core/QuickForm/Action/Reload.php
@@ -45,7 +45,7 @@ class CRM_Core_QuickForm_Action_Reload extends CRM_Core_QuickForm_Action {
    *   Reference to state machine object.
    *
    * @return \CRM_Core_QuickForm_Action_Reload
-  @access public
+   * @access public
    */
   public function __construct(&$stateMachine) {
     parent::__construct($stateMachine);
diff --git a/CRM/Core/QuickForm/Action/Submit.php b/CRM/Core/QuickForm/Action/Submit.php
index 7becd87e3a..b5bf6c625b 100644
--- a/CRM/Core/QuickForm/Action/Submit.php
+++ b/CRM/Core/QuickForm/Action/Submit.php
@@ -42,7 +42,7 @@ class CRM_Core_QuickForm_Action_Submit extends CRM_Core_QuickForm_Action {
    *   Reference to state machine object.
    *
    * @return \CRM_Core_QuickForm_Action_Submit
-  @access public
+   * @access public
    */
   public function __construct(&$stateMachine) {
     parent::__construct($stateMachine);
diff --git a/CRM/Core/QuickForm/Action/Upload.php b/CRM/Core/QuickForm/Action/Upload.php
index 8359a7867a..7d398c3a49 100644
--- a/CRM/Core/QuickForm/Action/Upload.php
+++ b/CRM/Core/QuickForm/Action/Upload.php
@@ -58,7 +58,7 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action {
    *   Element names of the various uploadable files.
    *
    * @return \CRM_Core_QuickForm_Action_Upload
-  @access public
+   * @access public
    */
   public function __construct(&$stateMachine, $uploadDir, $uploadNames) {
     parent::__construct($stateMachine);
diff --git a/CRM/Core/Selector/Controller.php b/CRM/Core/Selector/Controller.php
index cc2c5d48e1..534cef9eb4 100644
--- a/CRM/Core/Selector/Controller.php
+++ b/CRM/Core/Selector/Controller.php
@@ -193,7 +193,7 @@ class CRM_Core_Selector_Controller {
    * @param null $case
    *
    * @return \CRM_Core_Selector_Controller
-  @access public
+   * @access public
    */
   public function __construct($object, $pageID, $sortID, $action, $store = NULL, $output = self::TEMPLATE, $prefix = NULL, $case = NULL) {
 
diff --git a/CRM/Core/StateMachine.php b/CRM/Core/StateMachine.php
index a9bff2481f..ed0886fc1f 100644
--- a/CRM/Core/StateMachine.php
+++ b/CRM/Core/StateMachine.php
@@ -91,7 +91,7 @@ class CRM_Core_StateMachine {
    * @param \const|int $action
    *
    * @return \CRM_Core_StateMachine
-  @access public
+   * @access public
    */
   public function __construct(&$controller, $action = CRM_Core_Action::NONE) {
     $this->_controller = &$controller;
diff --git a/CRM/Event/Selector/Search.php b/CRM/Event/Selector/Search.php
index ea97eb5afb..24e23b36a8 100644
--- a/CRM/Event/Selector/Search.php
+++ b/CRM/Event/Selector/Search.php
@@ -159,7 +159,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co
    * @param null $compContext
    *
    * @return \CRM_Event_Selector_Search
-  @access public
+   * @access public
    */
   function __construct(
     &$queryParams,
diff --git a/CRM/Extension/Manager/Payment.php b/CRM/Extension/Manager/Payment.php
index 1926804fbd..6eac34c6fc 100644
--- a/CRM/Extension/Manager/Payment.php
+++ b/CRM/Extension/Manager/Payment.php
@@ -36,7 +36,7 @@
 class CRM_Extension_Manager_Payment extends CRM_Extension_Manager_Base {
 
   /**
-  @var CRM_Extension_Mapper
+   * @var CRM_Extension_Mapper
    */
   protected $mapper;
 
diff --git a/CRM/Grant/Selector/Search.php b/CRM/Grant/Selector/Search.php
index 09e9b67acf..4905763d86 100644
--- a/CRM/Grant/Selector/Search.php
+++ b/CRM/Grant/Selector/Search.php
@@ -145,7 +145,7 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co
    * @param string $context
    *
    * @return \CRM_Grant_Selector_Search
-  @access public
+   * @access public
    */
   function __construct(
     &$queryParams,
diff --git a/CRM/Mailing/Selector/Browse.php b/CRM/Mailing/Selector/Browse.php
index 44d3b49bda..fd75d3329b 100644
--- a/CRM/Mailing/Selector/Browse.php
+++ b/CRM/Mailing/Selector/Browse.php
@@ -61,7 +61,7 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_
    *
    *
    * @return \CRM_Mailing_Selector_Browse
-  @access public
+   * @access public
    */
   public function __construct() {
   }
diff --git a/CRM/Mailing/Selector/Event.php b/CRM/Mailing/Selector/Event.php
index 4a36c1cb26..fec0d400d6 100644
--- a/CRM/Mailing/Selector/Event.php
+++ b/CRM/Mailing/Selector/Event.php
@@ -96,7 +96,7 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C
    *   If the event type is a click-through, do we want only those from a specific url?.
    *
    * @return \CRM_Mailing_Selector_Event
-  @access public
+   * @access public
    */
   public function __construct($event, $distinct, $mailing, $job = NULL, $url = NULL) {
     $this->_event_type  = $event;
diff --git a/CRM/Mailing/Selector/Search.php b/CRM/Mailing/Selector/Search.php
index d1d93befcf..d326e753c0 100644
--- a/CRM/Mailing/Selector/Search.php
+++ b/CRM/Mailing/Selector/Search.php
@@ -149,7 +149,7 @@ class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_
    * @param null $compContext
    *
    * @return \CRM_Mailing_Selector_Search
-  @access public
+   * @access public
    */
   function __construct(
     &$queryParams,
diff --git a/CRM/Member/BAO/MembershipStatus.php b/CRM/Member/BAO/MembershipStatus.php
index bc20c9318a..7f1d6e6c51 100644
--- a/CRM/Member/BAO/MembershipStatus.php
+++ b/CRM/Member/BAO/MembershipStatus.php
@@ -232,7 +232,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus {
    *   Membership params as available to calling function - passed to the hook.
    *
    * @return array
-  @static
+   * @static
    */
   static function getMembershipStatusByDate(
     $startDate, $endDate, $joinDate,
@@ -384,7 +384,7 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus {
    * Function that return the status ids whose is_current_member is set
    *
    * @return array
-  @static
+   * @static
    */
   public static function getMembershipStatusCurrent() {
     $statusIds = array();
diff --git a/CRM/Member/Selector/Search.php b/CRM/Member/Selector/Search.php
index b1463e0f06..2206144284 100644
--- a/CRM/Member/Selector/Search.php
+++ b/CRM/Member/Selector/Search.php
@@ -145,7 +145,7 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C
    * @param string $context
    *
    * @return \CRM_Member_Selector_Search
-  @access public
+   * @access public
    */
   function __construct(
     &$queryParams,
diff --git a/CRM/Pledge/Selector/Search.php b/CRM/Pledge/Selector/Search.php
index 1f867ceb8d..160d3dd02b 100644
--- a/CRM/Pledge/Selector/Search.php
+++ b/CRM/Pledge/Selector/Search.php
@@ -148,7 +148,7 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base {
    * @param string $context
    *
    * @return \CRM_Pledge_Selector_Search
-  @access public
+   * @access public
    */
   function __construct(
     &$queryParams,
diff --git a/CRM/Profile/Selector/Listings.php b/CRM/Profile/Selector/Listings.php
index 1d8cbffcdd..f464c7b297 100644
--- a/CRM/Profile/Selector/Listings.php
+++ b/CRM/Profile/Selector/Listings.php
@@ -140,7 +140,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR
    * @param bool $linkToUF
    *
    * @return \CRM_Profile_Selector_Listings
-  @access public
+   * @access public
    */
   function __construct(
     &$params,
diff --git a/CRM/Upgrade/Form.php b/CRM/Upgrade/Form.php
index 2114c9e575..f72b5a5360 100644
--- a/CRM/Upgrade/Form.php
+++ b/CRM/Upgrade/Form.php
@@ -91,7 +91,7 @@ class CRM_Upgrade_Form extends CRM_Core_Form {
    *   The name of the form if different from class name.
    *
    * @return \CRM_Core_Form
-  @access public
+   * @access public
    */
   /**
    * @param null|object $state
diff --git a/CRM/Utils/Sort.php b/CRM/Utils/Sort.php
index 8701fcb55d..c9a30738e5 100644
--- a/CRM/Utils/Sort.php
+++ b/CRM/Utils/Sort.php
@@ -122,7 +122,7 @@ class CRM_Utils_Sort {
    *   Order to sort.
    *
    * @return \CRM_Utils_Sort
-  @access public
+   * @access public
    */
   public function __construct(&$vars, $defaultSortOrder = NULL) {
     $this->_vars = array();
diff --git a/api/v3/CustomField.php b/api/v3/CustomField.php
index 56a416c41d..3a73c916d3 100644
--- a/api/v3/CustomField.php
+++ b/api/v3/CustomField.php
@@ -36,17 +36,6 @@
  * @version $Id: CustomField.php 30879 2010-11-22 15:45:55Z shot $
  */
 
-/**
- * Most API functions take in associative arrays ( name => value pairs
- * as parameters. Some of the most commonly used parameters are
- * described below
- *
- * @param array $params
- *   An associative array used in construction.
- * retrieval of the object
- *
- */
-
 /**
  * Create a 'custom field' within a custom field group.
  * We also empty the static var in the getfields
@@ -56,7 +45,8 @@
  * @param $params
  *   Array Associative array of property name/value pairs to create new custom field.
  *
- * @return Newly API success object
+ * @return array
+ *   API success array
  *
  * @access public
  *
@@ -90,6 +80,7 @@ function _civicrm_api3_custom_field_flush_static_caches() {
   civicrm_api('custom_field', 'getfields', array('version' => 3, 'cache_clear' => 1));
   CRM_Core_BAO_UFField::getAvailableFieldsFlat(TRUE);
 }
+
 /**
  * Adjust Metadata for Create action
  *
@@ -123,7 +114,6 @@ function _civicrm_api3_custom_field_create_spec(&$params) {
  * @access public
  **/
 function civicrm_api3_custom_field_delete($params) {
-
   $field = new CRM_Core_BAO_CustomField();
   $field->id = $params['id'];
   $field->find(TRUE);
@@ -137,10 +127,9 @@ function civicrm_api3_custom_field_delete($params) {
  *
  * @param array $params
  *   Array to search on.
- * {*
  *
  * @return array
-@getfields CustomField_get}
+ * @getfields CustomField_get
  * @access public
  *
  **/
@@ -162,7 +151,7 @@ function civicrm_api3_custom_field_get($params) {
  *   Collect validation errors.
  *
  * @return array
-   *   Validation errors
+ *   Validation errors
  * @todo remove this function - not in use but need to review functionality before
  * removing as it might be useful in wrapper layer
  */