Code tidy ups

diff --git a/CRM/Activity/BAO/Activity.php b/CRM/Activity/BAO/Activity.php
index 50e65192e389b6d618291fd496cdb341a9fcb56a..0730ca850ca6dfba635f0c9b521bcad7c5c20fa6 100644 (file)
--- a/CRM/Activity/BAO/Activity.php
+++ b/CRM/Activity/BAO/Activity.php
@@ -33,8 +33,7 @@
  */
 
 /**
- * This class is for activity functions
- *
+ * This class is for activity functions.s
  */
 class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
 
@@ -2126,11 +2125,11 @@ AND cl.modified_id  = c.id
   }
 
   /**
-   * Restore the activity
+   * Restore the activity.
    *
    * @param array $params
    *
-   * @return void
+   * @return CRM_Activity_DAO_Activity
    */
   public static function restoreActivity(&$params) {
     $activity = new CRM_Activity_DAO_Activity();

diff --git a/CRM/Admin/Form/Setting.php b/CRM/Admin/Form/Setting.php
index 0740797e8a38f59ce8af97e6d69a802c2d5b9c35..cafc645b660dfb512f972b980d37add993e751f3 100644 (file)
--- a/CRM/Admin/Form/Setting.php
+++ b/CRM/Admin/Form/Setting.php
@@ -43,10 +43,8 @@ class CRM_Admin_Form_Setting extends CRM_Core_Form {
 
   /**
    * Set default values for the form.
-   * default values are retrieved from the database
    *
-   *
-   * @return void
+   * Default values are retrieved from the database.
    */
   public function setDefaultValues() {
     if (!$this->_defaults) {
@@ -168,10 +166,7 @@ class CRM_Admin_Form_Setting extends CRM_Core_Form {
   }
 
   /**
-   * Process the form submission
-   *
-   *
-   * @return void
+   * Process the form submission.
    */
   public function postProcess() {
     // store the submitted values in an array

diff --git a/CRM/Contact/Form/Edit/Phone.php b/CRM/Contact/Form/Edit/Phone.php
index b48758e50d68d885dd737f6201ea73a7d2ea1350..28b44f071d163060fc2aa64913684fd35e255e12 100644 (file)
--- a/CRM/Contact/Form/Edit/Phone.php
+++ b/CRM/Contact/Form/Edit/Phone.php
@@ -38,7 +38,7 @@
 class CRM_Contact_Form_Edit_Phone {
 
   /**
-   * Build the form object elements for a phone object
+   * Build the form object elements for a phone object.
    *
    * @param CRM_Core_Form $form
    *   Reference to the form object.
@@ -46,8 +46,6 @@ class CRM_Contact_Form_Edit_Phone {
    *   Block number to build.
    * @param bool $blockEdit
    *   Is it block edit.
-   *
-   * @return void
    */
   public static function buildQuickForm(&$form, $addressBlockCount = NULL, $blockEdit = FALSE) {
     // passing this via the session is AWFUL. we need to fix this

diff --git a/CRM/Contact/Form/RelatedContact.php b/CRM/Contact/Form/RelatedContact.php
index 487da255cb841f576ccc9b9c90f8b96e91d28b99..6885bcc14b381bbee24dddbb89e46b410318dd91 100644 (file)
--- a/CRM/Contact/Form/RelatedContact.php
+++ b/CRM/Contact/Form/RelatedContact.php
@@ -111,9 +111,7 @@ class CRM_Contact_Form_RelatedContact extends CRM_Core_Form {
   }
 
   /**
-   * Build the form object
-   *
-   * @return void
+   * Build the form object.
    */
   public function buildQuickForm() {
     $params = array();

diff --git a/CRM/Contact/Form/Task.php b/CRM/Contact/Form/Task.php
index e9ca3c6caca3586df2175180cd4c19679b4bf699..a7f572badf7f0a4ce6d2951e18214738e7b07c33 100644 (file)
--- a/CRM/Contact/Form/Task.php
+++ b/CRM/Contact/Form/Task.php
@@ -34,7 +34,6 @@
 
 /**
  * This class generates form components for search-result tasks
- *
  */
 class CRM_Contact_Form_Task extends CRM_Core_Form {
 
@@ -323,9 +322,9 @@ class CRM_Contact_Form_Task extends CRM_Core_Form {
 
 
   /**
-   * Set default values for the form. Relationship that in edit/view action
-   * the default values are retrieved from the database
+   * Set default values for the form. Relationship that in edit/view action.
    *
+   * The default values are retrieved from the database.
    *
    * @return array
    */
@@ -348,7 +347,7 @@ class CRM_Contact_Form_Task extends CRM_Core_Form {
   }
 
   /**
-   * Process the form after the input has been submitted and validated
+   * Process the form after the input has been submitted and validated.
    */
   public function postProcess() {
   }

diff --git a/CRM/Contact/Selector/Custom.php b/CRM/Contact/Selector/Custom.php
index 4e8eed51e4b8de4a467dfc98991214ded59fea4f..5445b08d25c75a025796a9918d360743114ced22 100644 (file)
--- a/CRM/Contact/Selector/Custom.php
+++ b/CRM/Contact/Selector/Custom.php
@@ -36,7 +36,6 @@
  * This class is used to retrieve and display a range of
  * contacts that match the given criteria (specifically for
  * results of advanced search options.
- *
  */
 class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
 
@@ -250,7 +249,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
   /**
    * Returns total number of rows for the query.
    *
-   * @param
+   * @param null $action
    *
    * @return int
    *   Total number of rows

diff --git a/CRM/Contribute/Controller/ContributionPage.php b/CRM/Contribute/Controller/ContributionPage.php
index 12d8b8d15ac43f608dc3cbef4ecb583a8ed253b7..d93223655314a7ffca4d03f50a7c658f9b45f81a 100644 (file)
--- a/CRM/Contribute/Controller/ContributionPage.php
+++ b/CRM/Contribute/Controller/ContributionPage.php
@@ -41,24 +41,22 @@
  * Typically the first form will display the search criteria and it's results
  *
  * The second form is used to process search results with the asscociated actions
- *
  */
 class CRM_Contribute_Controller_ContributionPage extends CRM_Core_Controller {
 
   /**
-   * Class constructor
+   * Class constructor.
+   *
+   * @param string $title
+   * @param bool|int $action
+   * @param bool $modal
    */
   public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
 
     parent::__construct($title, $modal);
-
-
     $this->_stateMachine = new CRM_Contribute_StateMachine_ContributionPage($this, $action);
-
-    // create and instantiate the pages
+    // Create and instantiate the pages.
     $this->addPages($this->_stateMachine, $action);
-
-    // add all the actions
     $this->addActions();
   }
 }

diff --git a/CRM/Core/Controller/Simple.php b/CRM/Core/Controller/Simple.php
index 7606058132e1a1060854a93600f070b6c8155d91..0f03b5603005322154a2fb709c6c036381477e91 100644 (file)
--- a/CRM/Core/Controller/Simple.php
+++ b/CRM/Core/Controller/Simple.php
@@ -38,7 +38,7 @@
 class CRM_Core_Controller_Simple extends CRM_Core_Controller {
 
   /**
-   * Constructor
+   * Constructor.
    *
    * @param null $path
    * @param bool $title

diff --git a/CRM/SMS/Form/Provider.php b/CRM/SMS/Form/Provider.php
index e3d1910624fadf676e52660d38e167cb3204ce98..86df3cec8a65e7e273444390dd08fd8f5a50591c 100644 (file)
--- a/CRM/SMS/Form/Provider.php
+++ b/CRM/SMS/Form/Provider.php
@@ -165,10 +165,7 @@ class CRM_SMS_Form_Provider extends CRM_Core_Form {
   }
 
   /**
-   * Process the form submission
-   *
-   *
-   * @return void
+   * Process the form submission.
    */
   public function postProcess() {