INFRA-132 - Cleanup stray comments
authorColeman Watts <coleman@civicrm.org>
Tue, 13 Jan 2015 02:13:48 +0000 (21:13 -0500)
committerColeman Watts <coleman@civicrm.org>
Tue, 13 Jan 2015 02:13:48 +0000 (21:13 -0500)
49 files changed:
CRM/Activity/Page/UserDashboard.php
CRM/Activity/StateMachine/Search.php
CRM/Case/Audit/AuditConfig.php
CRM/Case/Page/CaseDetails.php
CRM/Case/Page/DashBoard.php
CRM/Case/Page/Tab.php
CRM/Contact/BAO/Relationship.php
CRM/Contact/Page/DedupeException.php
CRM/Contact/Page/View/ContactSmartGroup.php
CRM/Contact/Page/View/GroupContact.php
CRM/Contact/Page/View/Log.php
CRM/Contact/Page/View/Note.php
CRM/Contact/Page/View/Relationship.php
CRM/Contact/Page/View/Sunlight.php
CRM/Contact/Page/View/Tag.php
CRM/Contact/Page/View/UserDashBoard/GroupContact.php
CRM/Contribute/Form/AdditionalInfo.php
CRM/Contribute/Form/Task/Invoice.php
CRM/Contribute/Page/ContributionRecur.php
CRM/Contribute/Page/DashBoard.php
CRM/Contribute/Page/SubscriptionStatus.php
CRM/Contribute/Page/Tab.php
CRM/Contribute/Page/UserDashboard.php
CRM/Core/BAO/Phone.php
CRM/Core/BAO/UFMatch.php
CRM/Core/Permission.php
CRM/Core/SelectValues.php
CRM/Event/BAO/Participant.php
CRM/Event/Page/DashBoard.php
CRM/Event/Page/Tab.php
CRM/Event/Page/UserDashboard.php
CRM/Financial/BAO/PaymentProcessor.php
CRM/Grant/Page/DashBoard.php
CRM/Grant/Page/Tab.php
CRM/Mailing/BAO/TrackableURL.php
CRM/Mailing/Page/Tab.php
CRM/Member/Page/DashBoard.php
CRM/Member/Page/Tab.php
CRM/Member/Page/UserDashboard.php
CRM/Pledge/Page/DashBoard.php
CRM/Pledge/Page/Payment.php
CRM/Pledge/Page/Tab.php
CRM/Pledge/Page/UserDashboard.php
CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php
CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php
CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php
CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php
CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php
CRM/Utils/Mail.php

index 824540bbc83016c175c6a92fd53ea3891f62ae16..04f1eb9b3c5b01ddd129c7bacdc8d1790491e780 100644 (file)
@@ -41,7 +41,7 @@ class CRM_Activity_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoar
   /**
    * List participations for the UF user
    *
-   * return null
+   * @return null
    */
   public function listActivities() {
 
@@ -68,7 +68,7 @@ class CRM_Activity_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoar
    * the main function that is called when the page
    * loads, it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     parent::preProcess();
index 3525c173569a1ad8bcc55bbbaa8b28c5cb940108..84a0752e386c37027deea811a2eebf5d2535bd38 100644 (file)
@@ -43,7 +43,7 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine {
   /**
    * Class constructor
    * @param object $controller
-   * @param \const|int $action
+   * @param int $action
    */
   public function __construct($controller, $action = CRM_Core_Action::NONE) {
     parent::__construct($controller, $action);
@@ -105,9 +105,6 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine {
    * beginning from the final state, but retain the same session
    * values
    *
-   * @return boolean
-   */
-  /**
    * @return bool
    */
   public function shouldReset() {
index 4a2beeb9aa2110bff183b61fbbdcc230a116b172..03f28fe9980373b88d5c3e907002ae35648618ce 100644 (file)
@@ -131,12 +131,9 @@ class CRM_Case_Audit_AuditConfig {
     }
   }
 
-  /* inRegion
-   *
-   * Check if label $n is explicitly listed in region $r in the config.
-   */
-
   /**
+   * Check if label $n is explicitly listed in region $r in the config.
+   *
    * @param $n
    * @param $r
    *
@@ -151,12 +148,9 @@ class CRM_Case_Audit_AuditConfig {
     }
   }
 
-  /* includeInRegion
-   *
-   * Should field $n be included in region $r, taking into account exclusion rules.
-   */
-
   /**
+   * Should field $n be included in region $r, taking into account exclusion rules.
+   *
    * @param $n
    * @param $r
    *
@@ -176,12 +170,9 @@ class CRM_Case_Audit_AuditConfig {
     return $add_it;
   }
 
-  /* includeTime
-   *
-   * Should the time component of field $n in region $r be displayed?
-   */
-
   /**
+   * Should the time component of field $n in region $r be displayed?
+   *
    * @param $n
    * @param $r
    *
@@ -210,25 +201,19 @@ class CRM_Case_Audit_AuditConfig {
     return $retval;
   }
 
-  /* getRegions
-   *
-   * Return a list of all the regions in the config file.
-   */
-
   /**
+   * Return a list of all the regions in the config file.
+   *
    * @return array
    */
   public function getRegions() {
     return array_keys($this->regionFieldList);
   }
 
-  /* sort
-   *
+  /**
    * Sort a group of fields for a given region according to the order in the config.
    * The array to be sorted should have elements that have a member with a key of 'label', and the value should be the field label.
-   */
-
-  /**
+   *
    * @param $f
    * @param $r
    */
@@ -242,13 +227,10 @@ class CRM_Case_Audit_AuditConfig {
     uasort($f, array(&$this, "compareFields"));
   }
 
-  /* compareFields
-   *
+  /**
    * This is intended to be called as a sort callback function, returning whether a field in a region comes before or after another one.
    * See also PHP's usort().
-   */
-
-  /**
+   *
    * @param $a
    * @param $b
    *
index 60e520ba400a64f22479d42e946bc24b9eb5e4f2..f74113a8d0a12d7eeaee14a8a3ecd3b0c571e7ba 100644 (file)
@@ -38,7 +38,7 @@ class CRM_Case_Page_CaseDetails extends CRM_Core_Page {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
index 892bffd7b134e491256e65c9c6b3bd4928f3dc29..2e8b94903de7e124dc40aa47e81131d5897118f4 100644 (file)
@@ -107,7 +107,7 @@ class CRM_Case_Page_DashBoard extends CRM_Core_Page {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index d76d17c8807ebb3c19dd47c4faacf7a7e57f6638..f02272dc480655e4df56c01df9ef799322d80b83 100644 (file)
@@ -140,7 +140,7 @@ class CRM_Case_Page_Tab extends CRM_Core_Page {
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function browse() {
 
@@ -163,7 +163,7 @@ class CRM_Case_Page_Tab extends CRM_Core_Page {
   /**
    * called when action is update or new
    *
-   * return null
+   * @return null
    */
   public function edit() {
     $config = CRM_Core_Config::singleton();
@@ -183,7 +183,7 @@ class CRM_Case_Page_Tab extends CRM_Core_Page {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $contactID = CRM_Utils_Request::retrieve('cid', 'Positive', CRM_Core_DAO::$_nullArray);
index 6dd71afc8a24f6f942389b1dc9a2148367007ea9..fd3a24225df99bebd7f08ac3f9f55e2fc5f3df6e 100644 (file)
@@ -896,9 +896,8 @@ WHERE  relationship_type_id = " . CRM_Utils_Type::escape($type, 'Integer');
    * @param array $params
    *   Array of extra values including relationship_type_id per api spec.
    *
-   * return string the query for this diretion
-   *
    * @return array
+   *   [select, from, where]
    */
   public static function makeURLClause($contactId, $status, $numRelationship, $count, $relationshipId, $direction, $params = array()) {
     $select = $from = $where = '';
@@ -1025,7 +1024,7 @@ LEFT JOIN  civicrm_country ON (civicrm_address.country_id = civicrm_country.id)
   }
 
   /**
-   * This is the function to get the list of relationships
+   * Get a list of relationships
    *
    * @param int $contactId
    *   Contact id.
@@ -1035,19 +1034,17 @@ LEFT JOIN  civicrm_country ON (civicrm_address.country_id = civicrm_country.id)
    *   No of relationships to display (limit).
    * @param int $count
    *   Get the no of relationships.
-   * $param int $relationshipId relationship id
-   * $param array $links the list of links to display
-   * $param int   $permissionMask  the permission mask to be applied for the actions
-   * $param boolean $permissionedContact to return only permissioned Contact
-   * $param array $params array of variables consistent with filters supported by the api
-   * return array $values relationship records
    * @param int $relationshipId
-   * @param null $links
-   * @param null $permissionMask
+   * @param array $links
+   *   the list of links to display
+   * @param int $permissionMask
+   *   the permission mask to be applied for the actions
    * @param bool $permissionedContact
+   *   to return only permissioned Contact
    * @param array $params
    *
    * @return array|int
+   *   relationship records
    */
   static function getRelationship(
     $contactId = NULL,
index db0e324281429ecc08d638da6a8bb64390581e1a..649e0ff7a35b4ad476c3a206ebf9c1935c3477fa 100644 (file)
@@ -81,7 +81,7 @@ class CRM_Contact_Page_DedupeException extends CRM_Core_Page {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index f72911e3601955e694cbba221bd9267e3385e41c..7ac5c0a5f4a5900031128981aa13bcde6f129813 100644 (file)
@@ -42,7 +42,7 @@ class CRM_Contact_Page_View_ContactSmartGroup extends CRM_Core_Page {
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function browse() {
     $in = CRM_Contact_BAO_GroupContact::getContactGroup($this->_contactId, 'Added');
@@ -100,7 +100,7 @@ class CRM_Contact_Page_View_ContactSmartGroup extends CRM_Core_Page {
    * when the page loads, it decides the which action has
    * to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index 01d5c7cdf15c922fc71a57c3520dc3ea69c94476..10251a07e689dea46d5c91d76fd3d22110a6dcd4 100644 (file)
@@ -37,7 +37,7 @@ class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page {
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function browse() {
 
@@ -74,7 +74,7 @@ class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page {
    *
    * @param int $groupId
    *
-   * return null
+   * @return null
    */
   public function edit($groupId = NULL) {
     $controller = new CRM_Core_Controller_Simple(
@@ -119,7 +119,7 @@ class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page {
    * when the page loads, it decides the which action has
    * to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index 3b8da83952a4356350c88962783289dcc08a6fb9..92740f10484f62ea9b8180115f4ed0069b7abec7 100644 (file)
@@ -37,7 +37,7 @@ class CRM_Contact_Page_View_Log extends CRM_Core_Page {
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function browse() {
     $loggingReport = CRM_Core_BAO_Log::useLoggingReport();
@@ -89,7 +89,7 @@ class CRM_Contact_Page_View_Log extends CRM_Core_Page {
   /**
    * the main function that is called when the page loads, it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index f3039e474b7e8dcc30a678648efd58576dc51547..760a86a5b20774a54bc7816522d0dda21dcfa93c 100644 (file)
@@ -82,7 +82,7 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page {
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function browse() {
     $note = new CRM_Core_DAO_Note();
@@ -161,7 +161,7 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page {
   /**
    * called when action is update or new
    *
-   * return null
+   * @return null
    */
   public function edit() {
     $controller = new CRM_Core_Controller_Simple('CRM_Note_Form_Note', ts('Contact Notes'), $this->_action);
@@ -215,7 +215,7 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index 5043d37f47f026fb368184375af428c2b837beee..0e20b552f53ef640fc657ff9243c2785041807d8 100644 (file)
@@ -135,7 +135,7 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page {
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function browse() {
     // do nothing :) we are using datatable for rendering relationship selectors
@@ -144,7 +144,7 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page {
   /**
    * called when action is update or new
    *
-   * return null
+   * @return null
    */
   public function edit() {
     $controller = new CRM_Core_Controller_Simple('CRM_Contact_Form_Relationship', ts('Contact Relationships'), $this->_action);
@@ -201,7 +201,7 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
@@ -260,7 +260,7 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page {
   /**
    * called to delete the relationship of a contact
    *
-   * return null
+   * @return null
    */
   public function delete() {
     // calls a function to delete relationship
index 2d064872010ae833c2a82567e62ad5c501b3e7d3..09b2d1148f0a5fd2b00dd19245b1b07525b91163 100644 (file)
@@ -37,7 +37,7 @@ class CRM_Contact_Page_View_Sunlight extends CRM_Contact_Page_View {
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function browse() {
     // get the primary city, state and zip for the contact
@@ -56,7 +56,7 @@ class CRM_Contact_Page_View_Sunlight extends CRM_Contact_Page_View {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index b914a29ce72e6c4068b2fc2b54471d2d62a62dc4..dd9e83f736537d9f60d7fc13d81abed7a4b8f632 100644 (file)
@@ -37,7 +37,7 @@ class CRM_Contact_Page_View_Tag extends CRM_Core_Page {
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function browse() {
     $controller = new CRM_Core_Controller_Simple('CRM_Tag_Form_Tag', ts('Contact Tags'), $this->_action);
@@ -68,7 +68,7 @@ class CRM_Contact_Page_View_Tag extends CRM_Core_Page {
    * the main function that is called when the page loads
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index 05a908ae0b2c504a27d0218ab479498cad73193c..e8570e9201f483c2bcb8f9c14a507f9fe7140aa7 100644 (file)
@@ -37,7 +37,7 @@ class CRM_Contact_Page_View_UserDashBoard_GroupContact extends CRM_Contact_Page_
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function browse() {
     $count = CRM_Contact_BAO_GroupContact::getContactGroup(
@@ -79,7 +79,7 @@ class CRM_Contact_Page_View_UserDashBoard_GroupContact extends CRM_Contact_Page_
    *
    * @param int $groupId
    *
-   * return null
+   * @return null
    */
   public function edit($groupId = NULL) {
     $this->assign('edit', $this->_edit);
@@ -132,7 +132,7 @@ class CRM_Contact_Page_View_UserDashBoard_GroupContact extends CRM_Contact_Page_
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->edit();
index 31ec73c698d450cc332e823c38bcae02677d9fca..6de4ee2693007c8c4f991045d797d98390f7894b 100644 (file)
@@ -330,13 +330,12 @@ class CRM_Contribute_Form_AdditionalInfo {
   /**
    * Send email receipt.
    *
-   * @form object  of Contribution form.
-   *
    * @param CRM_Core_Form $form
+   *   instance of Contribution form.
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
-   * @$ccContribution boolen,  is it credit card contribution.
    * @param bool $ccContribution
+   *   is it credit card contribution.
    *
    * @return array
    */
index 3964720c61d7583fd4920fbc28a25582db5503cb..b95eb6f0312e7b8d4aa9812dce7524ee70f50ad6 100644 (file)
@@ -232,8 +232,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task {
   }
 
   /**
-   *
-   * process the PDf and email with activity and attachment
+   * Process the PDf and email with activity and attachment
    * on click of Print Invoices
    *
    * @param array $contribIDs
@@ -573,9 +572,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task {
   }
 
   /**
-   *
-   * This function is use for adding activity for
-   * Email Invoice and the PDF Invoice
+   * Add activity for Email Invoice and the PDF Invoice
    *
    * @param string $subject
    *   Activity subject.
@@ -623,16 +620,13 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task {
   }
 
   /**
+   * Create the Invoice file in upload folder for attachment
    *
-   * This function is use for creating the Invoice file in upload folder
-   * for attachment
-   *
-   * @param $html
+   * @param string $html
    *   Content for pdf in html format.
    *
-   * return $fileName of file which is in pdf format
-   *
    * @return string
+   *   Name of file which is in pdf format
    */
   static public function putFile($html) {
     require_once "packages/dompdf/dompdf_config.inc.php";
index 624f6faa967d0fdd85c98e26574f300148c1baa8..e69a98a79f7495af67dce4228c7ae003b5eb9f42 100644 (file)
@@ -94,7 +94,7 @@ class CRM_Contribute_Page_ContributionRecur extends CRM_Core_Page {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index 3a8030d3cd8abef97b6f164f2103374936240bcc..518f9e909c08e6de3c4e59d930ff62116d96d35a 100644 (file)
@@ -105,7 +105,7 @@ class CRM_Contribute_Page_DashBoard extends CRM_Core_Page {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index a691613d9839641f99942d8e3f5830ab20d3bf39..662b3cdce8e9ee04ef77d89b3e159bfdbce5193a 100644 (file)
@@ -38,7 +38,7 @@ class CRM_Contribute_Page_SubscriptionStatus extends CRM_Core_Page {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $task = CRM_Utils_Request::retrieve('task', 'String', CRM_Core_DAO::$_nullObject);
index 8335bc3f85b280109e1d6c4df2120ff8ab063d56..1d1ba4f993b25344f2542f59de13d3aadaf38585 100644 (file)
@@ -104,7 +104,7 @@ class CRM_Contribute_Page_Tab extends CRM_Core_Page {
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function browse() {
     // add annual contribution
@@ -200,7 +200,7 @@ class CRM_Contribute_Page_Tab extends CRM_Core_Page {
   /**
    * called when action is view
    *
-   * return null
+   * @return null
    */
   public function view() {
     $controller = new CRM_Core_Controller_Simple(
@@ -218,7 +218,7 @@ class CRM_Contribute_Page_Tab extends CRM_Core_Page {
   /**
    * called when action is update or new
    *
-   * return null
+   * @return null
    */
   public function edit() {
     // set https for offline cc transaction
@@ -273,7 +273,7 @@ class CRM_Contribute_Page_Tab extends CRM_Core_Page {
    * the main function that is called when the page
    * loads, it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index b403d2463e821a07397d1cfa68db4936855a16d0..d33b0a618e26798a22d6bc02e2435e9c0a58d4f4 100644 (file)
@@ -37,7 +37,7 @@ class CRM_Contribute_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBo
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function listContribution() {
     $controller = new CRM_Core_Controller_Simple(
@@ -146,7 +146,7 @@ class CRM_Contribute_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBo
    * the main function that is called when the page
    * loads, it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $invoiceSettings = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME, 'contribution_invoice_settings');
index 0eee6ce5392b3bd72e7cf0ba1edb4f1a681267e8..b83e8ff917045bb25c377414d5b959f96e35b2c3 100644 (file)
@@ -236,7 +236,7 @@ ORDER BY ph.is_primary DESC, phone_id ASC ";
    * @param $optionId
    *   Value of option to be deleted.
    *
-   * return void
+   * @return void
    */
   public static function setOptionToNull($optionId) {
     if (!$optionId) {
index dc3dbd4b1d95c8af86f859f70c20d59c07c6f0a9..a0781864430a5ea739f51253d796e239f808caa8 100644 (file)
@@ -615,10 +615,8 @@ AND    domain_id    = %4
    * @param int $ufID
    *   Uf id.
    *
-   * return array  $ufValues uf values.
-   * *
-   *
    * @return array
+   *   uf values.
    */
   public static function getUFValues($ufID = NULL) {
     if (!$ufID) {
index 2aa52ba13738d6ed55d3d4e802cb5f1d106620d5..9b4ca59a07081e71ddafadccb9ff1d6a40f60521 100644 (file)
@@ -673,7 +673,7 @@ class CRM_Core_Permission {
    * Validate user permission across
    * edit or view or with supportable acls.
    *
-   * return boolean true/false.
+   * @return boolean
    **/
   public static function giveMeAllACLs() {
     if (CRM_Core_Permission::check('view all contacts') ||
@@ -712,9 +712,8 @@ class CRM_Core_Permission {
    *
    * @param string $permission
    *
-   * return string $componentName the name of component.
-   *
-   * @return int|null|string
+   * @return null|string
+   *   the name of component.
    */
   public static function getComponentName($permission) {
     $componentName = NULL;
index 7cd219f62c37550bada858473ea5e42019347b58..089bbb9150c1d617fca0bf625de24a99eee0b1f1 100644 (file)
@@ -39,6 +39,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Preferred mail format
+   * 
+   * @return array
    */
   public static function pmf() {
     return array(
@@ -50,6 +52,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Privacy options
+   *
+   * @return array
    */
   public static function privacy() {
     return array(
@@ -64,6 +68,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Various pre defined contact super types
+   *
+   * @return array
    */
   public static function contactType() {
     static $contactType = NULL;
@@ -75,6 +81,9 @@ class CRM_Core_SelectValues {
 
   /**
    * Various pre defined unit list
+   * 
+   * @param string $unitType
+   * @return array
    */
   public static function unitList($unitType = NULL) {
     $unitList = array(
@@ -90,6 +99,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Membership type unit
+   *
+   * @return array
    */
   public static function membershipTypeUnitList() {
     return self::unitList('duration');
@@ -97,6 +108,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Various pre defined period types
+   *
+   * @return array
    */
   public static function periodType() {
     return array(
@@ -107,6 +120,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Various pre defined email selection methods
+   *
+   * @return array
    */
   public static function emailSelectMethods() {
     return array(
@@ -119,6 +134,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Various pre defined member visibility options
+   *
+   * @return array
    */
   public static function memberVisibility() {
     return array(
@@ -129,6 +146,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Member auto-renew options
+   *
+   * @return array
    */
   public static function memberAutoRenew() {
     return array(
@@ -140,6 +159,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Various pre defined event dates
+   *
+   * @return array
    */
   public static function eventDate() {
     return array(
@@ -151,6 +172,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Custom form field types
+   *
+   * @return array
    */
   public static function customHtmlType() {
     return array(
@@ -177,6 +200,8 @@ class CRM_Core_SelectValues {
   /**
    * Various pre defined extensions for dynamic properties and groups
    *
+   * @return array
+   *
    */
   public static function customGroupExtends() {
     $customGroupExtends = array(
@@ -205,6 +230,8 @@ class CRM_Core_SelectValues {
   /**
    * Styles for displaying the custom data group
    *
+   * @return array
+   *
    */
   public static function customGroupStyle() {
     return array(
@@ -217,6 +244,7 @@ class CRM_Core_SelectValues {
   /**
    * For displaying the uf group types
    *
+   * @return array
    */
   public static function ufGroupTypes() {
     $ufGroupType = array(
@@ -236,6 +264,8 @@ class CRM_Core_SelectValues {
   /**
    * The status of a contact within a group
    *
+   * @return array
+   *
    */
   public static function groupContactStatus() {
     return array(
@@ -247,6 +277,8 @@ class CRM_Core_SelectValues {
 
   /**
    * List of Group Types
+   *
+   * @return array
    */
   public static function groupType() {
     return array(
@@ -258,9 +290,10 @@ class CRM_Core_SelectValues {
   /**
    * Compose the parameters for a date select object
    *
-   * @param string|NULL $type the type of date
-   * @param string|NULL $format date format ( QF format)
-   *
+   * @param string|NULL $type
+   *   the type of date
+   * @param string|NULL $format
+   *   date format (QF format)
    * @param null $minOffset
    * @param null $maxOffset
    *
@@ -268,7 +301,6 @@ class CRM_Core_SelectValues {
    *   the date array
    */
   public static function date($type = NULL, $format = NULL, $minOffset = NULL, $maxOffset = NULL) {
-
     $date = array(
       'addEmptyOption' => TRUE,
       'emptyOptionText' => ts('- select -'),
@@ -310,6 +342,7 @@ class CRM_Core_SelectValues {
   /**
    * Values for UF form visibility options
    *
+   * @return array
    */
   public static function ufVisibility() {
     return array(
@@ -322,6 +355,7 @@ class CRM_Core_SelectValues {
   /**
    * Values for group form visibility options
    *
+   * @return array
    */
   public static function groupVisibility() {
     return array(
@@ -333,7 +367,7 @@ class CRM_Core_SelectValues {
   /**
    * Different type of Mailing Components
    *
-   * return array
+   * @return array
    */
   public static function mailingComponents() {
     return array(
@@ -351,7 +385,7 @@ class CRM_Core_SelectValues {
   /**
    * Get hours
    *
-   *
+   * @return array
    */
   public function getHours() {
     $hours = array();
@@ -364,7 +398,7 @@ class CRM_Core_SelectValues {
   /**
    * Get minutes
    *
-   *
+   * @return array
    */
   public function getMinutes() {
     $minutes = array();
@@ -403,8 +437,7 @@ class CRM_Core_SelectValues {
   }
 
   /**
-   * Get the Address Standardization Providers from available
-   * plugins
+   * Get the Address Standardization Providers from available plugins
    *
    * @return array
    *   array of address standardization providers
@@ -420,7 +453,7 @@ class CRM_Core_SelectValues {
   /**
    * Different type of Mailing Tokens
    *
-   * return array
+   * @return array
    */
   public static function mailingTokens() {
     return array(
@@ -446,7 +479,7 @@ class CRM_Core_SelectValues {
   /**
    * Different type of Activity Tokens
    *
-   * return array
+   * @return array
    */
   public static function activityTokens() {
     return array(
@@ -460,7 +493,7 @@ class CRM_Core_SelectValues {
   /**
    * Different type of Membership Tokens
    *
-   * return array
+   * @return array
    */
   public static function membershipTokens() {
     return array(
@@ -477,7 +510,7 @@ class CRM_Core_SelectValues {
   /**
    * Different type of Event Tokens
    *
-   * return array
+   * @return array
    */
   public static function eventTokens() {
     return array(
@@ -501,7 +534,7 @@ class CRM_Core_SelectValues {
   /**
    * Different type of Event Tokens
    *
-   * return array
+   * @return array
    */
   public static function contributionTokens() {
     return array(
@@ -534,7 +567,7 @@ class CRM_Core_SelectValues {
   /**
    * Different type of Contact Tokens
    *
-   * return array
+   * @return array
    */
   public static function contactTokens() {
     static $tokens = NULL;
@@ -609,7 +642,7 @@ class CRM_Core_SelectValues {
   /**
    * Different type of Participant Tokens
    *
-   * return array
+   * @return array
    */
   public static function participantTokens() {
     static $tokens = NULL;
@@ -650,7 +683,9 @@ class CRM_Core_SelectValues {
   }
 
   /**
-   *  CiviCRM supported date input formats
+   * CiviCRM supported date input formats
+   *
+   * @return array
    */
   public static function getDatePluginInputFormats() {
     $dateInputFormats = array(
@@ -672,23 +707,25 @@ class CRM_Core_SelectValues {
     );
 
     /*
-         Year greater than 2000 get wrong result for following format
-         echo date( 'Y-m-d', strtotime( '7 Nov, 2001') );
-         echo date( 'Y-m-d', strtotime( '7 November, 2001') );
-         Return current year
-         expected :: 2001-11-07
-         output   :: 2009-11-07
-         However
-         echo date( 'Y-m-d', strtotime( 'Nov 7, 2001') );
-         echo date( 'Y-m-d', strtotime( 'November 7, 2001') );
-         gives proper result
-        */
+       Year greater than 2000 get wrong result for following format
+       echo date( 'Y-m-d', strtotime( '7 Nov, 2001') );
+       echo date( 'Y-m-d', strtotime( '7 November, 2001') );
+       Return current year
+       expected :: 2001-11-07
+       output   :: 2009-11-07
+       However
+       echo date( 'Y-m-d', strtotime( 'Nov 7, 2001') );
+       echo date( 'Y-m-d', strtotime( 'November 7, 2001') );
+       gives proper result
+     */
 
     return $dateInputFormats;
   }
 
   /**
    * Map date plugin and actual format that is used by PHP
+   *
+   * @return array
    */
   public static function datePluginToPHPFormats() {
     $dateInputFormats = array(
@@ -713,6 +750,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Time formats
+   *
+   * @return array
    */
   public static function getTimeFormats() {
     return array(
@@ -723,7 +762,11 @@ class CRM_Core_SelectValues {
 
   /**
    * Get numeric options
+   * 
+   * @param int $start
+   * @param int $end
    *
+   * @return array
    */
   public static function getNumericOptions($start = 0, $end = 10) {
     $numericOptions = array();
@@ -735,6 +778,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Barcode types
+   *
+   * @return array
    */
   public static function getBarcodeTypes() {
     return array(
@@ -745,6 +790,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Dedupe rule types
+   *
+   * @return array
    */
   public static function getDedupeRuleTypes() {
     return array(
@@ -756,6 +803,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Campaign group types
+   *
+   * @return array
    */
   public static function getCampaignGroupTypes() {
     return array(
@@ -766,6 +815,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Subscription history method
+   *
+   * @return array
    */
   public static function getSubscriptionHistoryMethods() {
     return array(
@@ -778,6 +829,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Premium units
+   *
+   * @return array
    */
   public static function getPremiumUnits() {
     return array(
@@ -790,6 +843,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Extension types
+   *
+   * @return array
    */
   public static function getExtensionTypes() {
     return array(
@@ -803,6 +858,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Job frequency
+   *
+   * @return array
    */
   public static function getJobFrequency() {
     return array(
@@ -814,6 +871,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Search builder operators
+   *
+   * @return array
    */
   public static function getSearchBuilderOperators() {
     return array(
@@ -838,6 +897,7 @@ class CRM_Core_SelectValues {
   /**
    * Profile group types
    *
+   * @return array
    */
   public static function getProfileGroupType() {
     $profileGroupType = array(
@@ -856,6 +916,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Word replacement match type
+   *
+   * @return array
    */
   public static function getWordReplacementMatchType() {
     return array(
@@ -866,6 +928,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Mailing group types
+   *
+   * @return array
    */
   public static function getMailingGroupTypes() {
     return array(
@@ -877,6 +941,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Mailing Job Status
+   *
+   * @return array
    */
   public static function getMailingJobStatus() {
     return array(
@@ -888,6 +954,9 @@ class CRM_Core_SelectValues {
     );
   }
 
+  /**
+   * @return array
+   */
   public static function billingMode() {
     return array(
       CRM_Core_Payment::BILLING_MODE_FORM => 'form',
@@ -898,6 +967,8 @@ class CRM_Core_SelectValues {
 
   /**
    * Frequency unit for schedule reminders
+   *
+   * @return array
    */
   public static function getScheduleReminderFrequencyUnits() {
     //@todo update schema to refer to option group direct & remove this
index 4f34ffca4ac5a4fdb164b51b1f79957591b8b4b8..fb282d354f1ac77d9e54983c6057cd36574a6f21 100644 (file)
@@ -1220,8 +1220,6 @@ UPDATE  civicrm_participant
    *   Update status id.
    * @param int $fromStatusId
    *   From status id.
-   *
-   * return  void
    * @param bool $returnResult
    * @param bool $skipCascadeRule
    *
@@ -1461,8 +1459,6 @@ UPDATE  civicrm_participant
    * @param string $mailType
    *   (eg 'approval', 'confirm', 'expired' ).
    *
-   * return  void
-   *
    * @return bool
    */
   static function sendTransitionParticipantMail(
index c10d80bba0acb62e828ffa037cbbf816e1ab1f6a..f6c1d100d2efe48cc08e01fc0e5f35659976f14e 100644 (file)
@@ -74,7 +74,7 @@ class CRM_Event_Page_DashBoard extends CRM_Core_Page {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index f5cd976faa955eea7432cd3ba354176a0737a072..1cc1f3f996248fffe6b3550efc5362f24ebb78e5 100644 (file)
@@ -40,7 +40,7 @@ class CRM_Event_Page_Tab extends CRM_Core_Page {
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function browse() {
     $controller = new CRM_Core_Controller_Simple(
@@ -72,7 +72,7 @@ class CRM_Event_Page_Tab extends CRM_Core_Page {
   /**
    * called when action is view
    *
-   * return null
+   * @return null
    */
   public function view() {
     // build associated contributions
@@ -93,7 +93,7 @@ class CRM_Event_Page_Tab extends CRM_Core_Page {
   /**
    * called when action is update or new
    *
-   * return null
+   * @return null
    */
   public function edit() {
     // set https for offline cc transaction
@@ -148,7 +148,7 @@ class CRM_Event_Page_Tab extends CRM_Core_Page {
   /**
    * the main function that is called when the page loads, it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
@@ -284,7 +284,7 @@ class CRM_Event_Page_Tab extends CRM_Core_Page {
    * used for the to show the associated
    * contribution for the participant
    *
-   * return null
+   * @return null
    */
   public function associatedContribution() {
     if (CRM_Core_Permission::access('CiviContribute')) {
index 5bd6e74e3db3dffeebb356f838ac508f11f1083b..b14799a9db7be9a64137db74bd817b585682ed0c 100644 (file)
@@ -41,7 +41,7 @@ class CRM_Event_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard {
   /**
    * List participations for the UF user
    *
-   * return null
+   * @return null
    */
   public function listParticipations() {
     $controller = new CRM_Core_Controller_Simple(
@@ -63,7 +63,7 @@ class CRM_Event_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard {
    * the main function that is called when the page
    * loads, it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     parent::preProcess();
index 1366ab75cdaa6f3ff566921d9ad70465e601f814..eedcf0f643953c90a10a0802626d10b2255f741b 100644 (file)
@@ -303,15 +303,15 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces
    * @return array
    */
   public static function getAllPaymentProcessors($mode, $reset = FALSE) {
-    /**
+    /*
      * $cacheKey = 'CRM_Financial_BAO_Payment_Processor_' . ($mode ? 'test' : 'all');
      * if (!$reset) {
-     * $processors = CRM_Utils_Cache::singleton()->get($cacheKey);
-     * if (!empty($processors)) {
-     * return $processors;
-     * }
+     *   $processors = CRM_Utils_Cache::singleton()->get($cacheKey);
+     *   if (!empty($processors)) {
+     *     return $processors;
+     *   }
      * }
-     * */
+     */
     $retrievalParameters = array(
       'is_active' => TRUE,
       'options' => array('sort' => 'is_default DESC, name'),
index d53f7c04ccc070352433be6128cb41addbcbef75..29429870a2697dcefbce22e69b2fe949b3c5f424 100644 (file)
@@ -57,7 +57,7 @@ class CRM_Grant_Page_DashBoard extends CRM_Core_Page {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index 0cd6e50f4935fe238464fd17796e55aa5eae5fde..37e055ca3ff9f75f1d65c5121278a0ba35479baf 100644 (file)
@@ -51,7 +51,7 @@ class CRM_Grant_Page_Tab extends CRM_Contact_Page_View {
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   function browse() {
     $controller = new CRM_Core_Controller_Simple('CRM_Grant_Form_Search', ts('Grants'), $this->_action);
@@ -72,7 +72,7 @@ class CRM_Grant_Page_Tab extends CRM_Contact_Page_View {
   /**
    * called when action is view
    *
-   * return null
+   * @return null
    */
   public function view() {
     $controller = new CRM_Core_Controller_Simple('CRM_Grant_Form_GrantView', 'View Grant', $this->_action);
@@ -86,7 +86,7 @@ class CRM_Grant_Page_Tab extends CRM_Contact_Page_View {
   /**
    * called when action is update or new
    *
-   * return null
+   * @return null
    */
   public function edit() {
     $controller = new CRM_Core_Controller_Simple('CRM_Grant_Form_Grant', 'Create grant', $this->_action);
@@ -132,7 +132,7 @@ class CRM_Grant_Page_Tab extends CRM_Contact_Page_View {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index bef5c534676b69a4e164c7da46cae63e7aa9b17e..1b0be1768ebe7f8d1bafea1be6e2c417248924f9 100644 (file)
@@ -111,7 +111,8 @@ class CRM_Mailing_BAO_TrackableURL extends CRM_Mailing_DAO_TrackableURL {
    * @param $url
    * @param $mailing_id
    *
-   * return int Url id of the given url and mail
+   * @return int
+   *   Url id of the given url and mail
    */
   public static function getTrackerURLId($url, $mailing_id) {
     $tracker = new CRM_Mailing_BAO_TrackableURL();
index 197aff8cd495c958bdd4655b3ea6d5ecc7c589f5..c2352b1870157f4d65c60e6789608950eb20cb28 100644 (file)
@@ -50,7 +50,7 @@ class CRM_Mailing_Page_Tab extends CRM_Contact_Page_View {
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function browse() {
   }
@@ -81,7 +81,7 @@ class CRM_Mailing_Page_Tab extends CRM_Contact_Page_View {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index 5e305677589a8e0ab88e5ed478350ecdeafa1e5a..42fa50fd01ddf08fe76860d2365a94d9008c242a 100644 (file)
@@ -440,7 +440,7 @@ class CRM_Member_Page_DashBoard extends CRM_Core_Page {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index 525f2b652983f6e73fce1a93eb2615209f73372e..6e9f766d92f3de7489f2912449bc9b9ac12a59f8 100644 (file)
@@ -48,7 +48,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page {
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function browse() {
     $links = self::links('all', $this->_isPaymentProcessor, $this->_accessContribution);
@@ -219,7 +219,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page {
   /**
    * called when action is view
    *
-   * return null
+   * @return null
    */
   public function view() {
     $controller = new CRM_Core_Controller_Simple(
@@ -237,7 +237,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page {
   /**
    * called when action is update or new
    *
-   * return null
+   * @return null
    */
   public function edit() {
     // set https for offline cc transaction
@@ -310,7 +310,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page {
   /**
    * the main function that is called when the page loads, it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
@@ -575,8 +575,11 @@ class CRM_Member_Page_Tab extends CRM_Core_Page {
   /**
    * used for the to show the associated
    * contribution for the membership
-   * @form array $form (ref.) an assoc array of name/value pairs
-   * return null
+   *
+   * @param int $contactId
+   * @param int $membershipId
+   *
+   * @return null
    */
   public static function associatedContribution($contactId = NULL, $membershipId = NULL) {
     $controller = new CRM_Core_Controller_Simple(
index eba8a181999349334293cd9d88cafc8acb2bc58d..a53740f9942f47aef5e003ca635192dbbe0cb690 100644 (file)
@@ -41,7 +41,7 @@ class CRM_Member_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard
   /**
    * List memberships for the UF user
    *
-   * return null
+   * @return null
    */
   public function listMemberships() {
     $membership = array();
@@ -96,7 +96,7 @@ class CRM_Member_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard
    * the main function that is called when the page
    * loads, it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     parent::preProcess();
index bb803326e67f9e6c11d9d459d5693ddcbf7c72be..d6d4d9edbaea28e3989ad172ae44b3c979b04a84 100644 (file)
@@ -96,7 +96,7 @@ class CRM_Pledge_Page_DashBoard extends CRM_Core_Page {
    * the main function that is called when the page loads,
    * it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index 766ba55e9d0f9c207031e4c5e53a643bcfde8017..f9f744a0d08ce9106955e789d199794ef66f58bc 100644 (file)
@@ -37,7 +37,7 @@ class CRM_Pledge_Page_Payment extends CRM_Core_Page {
   /**
    * the main function that is called when the page loads, it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
@@ -79,7 +79,7 @@ class CRM_Pledge_Page_Payment extends CRM_Core_Page {
   /**
    * called when action is update or new
    *
-   * return null
+   * @return null
    */
   public function edit() {
     $controller = new CRM_Core_Controller_Simple('CRM_Pledge_Form_Payment',
index 563de86d56ba93deae7b748b01620bcc4543488c..f0480a0e5f9fff9a09af5ef22b9b1fd9efbfabd9 100644 (file)
@@ -39,7 +39,7 @@ class CRM_Pledge_Page_Tab extends CRM_Core_Page {
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function browse() {
     $controller = new CRM_Core_Controller_Simple('CRM_Pledge_Form_Search', ts('Pledges'), $this->_action);
@@ -66,7 +66,7 @@ class CRM_Pledge_Page_Tab extends CRM_Core_Page {
   /**
    * called when action is view
    *
-   * return null
+   * @return null
    */
   public function view() {
     $controller = new CRM_Core_Controller_Simple('CRM_Pledge_Form_PledgeView',
@@ -83,7 +83,7 @@ class CRM_Pledge_Page_Tab extends CRM_Core_Page {
   /**
    * called when action is update or new
    *
-   * return null
+   * @return null
    */
   public function edit() {
     $controller = new CRM_Core_Controller_Simple('CRM_Pledge_Form_Pledge',
@@ -125,7 +125,7 @@ class CRM_Pledge_Page_Tab extends CRM_Core_Page {
   /**
    * the main function that is called when the page loads, it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     $this->preProcess();
index fdd0ac563a59786af7f846c9bdb49f5ebfb12bf5..e26b2ad9d7dd0788ee4e07173e7314969574d56d 100644 (file)
@@ -37,7 +37,7 @@ class CRM_Pledge_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard
   /**
    * called when action is browse
    *
-   * return null
+   * @return null
    */
   public function listPledges() {
     $controller = new CRM_Core_Controller_Simple(
@@ -72,7 +72,7 @@ class CRM_Pledge_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard
    * the main function that is called when the page
    * loads, it decides the which action has to be taken for the page.
    *
-   * return null
+   * @return null
    */
   public function run() {
     parent::preProcess();
index b0f7e4b29b1a16da0a0baeb7bfd4ea5247a0a5a1..ed86b1d692d731fb64fbb786a0940911b7bf1413 100644 (file)
@@ -340,7 +340,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO {
   /**
    * returns the list of fields that can be imported
    *
-   * return array
+   * @return array
    */
   static function &import($prefix = FALSE) {
     if (!(self::$_import)) {
@@ -363,7 +363,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO {
   /**
    * returns the list of fields that can be exported
    *
-   * return array
+   * @return array
    */
   static function &export($prefix = FALSE) {
     if (!(self::$_export)) {
index 08b1d3530e2c3d4881bf6e64d62ede7390ab01e1..0cd702e29bcdc08e747b0f35d2432d474178d092 100644 (file)
@@ -283,7 +283,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue extends CRM_Core_DAO {
   /**
    * returns the list of fields that can be imported
    *
-   * return array
+   * @return array
    */
   static function &import($prefix = FALSE) {
     if (!(self::$_import)) {
@@ -306,7 +306,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue extends CRM_Core_DAO {
   /**
    * returns the list of fields that can be exported
    *
-   * return array
+   * @return array
    */
   static function &export($prefix = FALSE) {
     if (!(self::$_export)) {
index 0646cf4e024aa7234920cce075b959c8d5852c2b..7c9d98e9812d991ea67fd5d79b9831c6bb675140 100644 (file)
@@ -259,7 +259,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem extends CRM_Core_DAO {
   /**
    * returns the list of fields that can be imported
    *
-   * return array
+   * @return array
    */
   static function &import($prefix = FALSE) {
     if (!(self::$_import)) {
@@ -282,7 +282,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem extends CRM_Core_DAO {
   /**
    * returns the list of fields that can be exported
    *
-   * return array
+   * @return array
    */
   static function &export($prefix = FALSE) {
     if (!(self::$_export)) {
index e39722dffa0398794fc699c29061016f5f23ba5a..e828e12c3ab3b3a783ccf59a431d6fac5644b252 100644 (file)
@@ -283,7 +283,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set extends CRM_Core_DAO {
   /**
    * returns the list of fields that can be imported
    *
-   * return array
+   * @return array
    */
   static function &import($prefix = FALSE) {
     if (!(self::$_import)) {
@@ -306,7 +306,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set extends CRM_Core_DAO {
   /**
    * returns the list of fields that can be exported
    *
-   * return array
+   * @return array
    */
   static function &export($prefix = FALSE) {
     if (!(self::$_export)) {
index 6020b3a4dad0255d64b0813740aaa556775128db..35de88c00c5477c574238d06e8110dd18f04c2e5 100644 (file)
@@ -184,7 +184,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity extends CRM_Core_DAO {
   /**
    * returns the list of fields that can be imported
    *
-   * return array
+   * @return array
    */
   static function &import($prefix = FALSE) {
     if (!(self::$_import)) {
@@ -207,7 +207,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity extends CRM_Core_DAO {
   /**
    * returns the list of fields that can be exported
    *
-   * return array
+   * @return array
    */
   static function &export($prefix = FALSE) {
     if (!(self::$_export)) {
index 116224e55874e0ff8a20e431c4b4571757ba3eb8..d076c10732af2ff69d17e84f04bb9878ab02f2f6 100644 (file)
@@ -55,7 +55,6 @@ class CRM_Utils_Mail {
    * @param array $params
    *   (by reference).
    *
-   *
    * @return boolean
    *   true if a mail was sent, else false
    */