Merge branch 'phpunit-ob-fix' of https://github.com/giant-rabbit/civicrm-core into...

[civicrm-core.git] / CRM / Contact / Form / Task / PDFLetterCommon.php

diff --git a/CRM/Contact/Form/Task/PDFLetterCommon.php b/CRM/Contact/Form/Task/PDFLetterCommon.php
index a3f091244e03efd3f4cb87ae0b5e34ccc681fe55..ea36fb09d5b8a5af671df926b9f5f66b4355b117 100644 (file)
--- a/CRM/Contact/Form/Task/PDFLetterCommon.php
+++ b/CRM/Contact/Form/Task/PDFLetterCommon.php
@@ -40,9 +40,9 @@
 class CRM_Contact_Form_Task_PDFLetterCommon {
 
   /**
-   * build all the data structures needed to build the form
+   * Build all the data structures needed to build the form
    *
-   * @param $form
+   * @param CRM_Core_Form $form
    *
    * @return void
    * @access public
@@ -64,8 +64,8 @@ class CRM_Contact_Form_Task_PDFLetterCommon {
   }
 
   /**
-   * @param $form
-   * @param $cid
+   * @param CRM_Core_Form $form
+   * @param int $cid
    */
   static function preProcessSingle(&$form, $cid) {
     $form->_contactIds = array($cid);
@@ -74,7 +74,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon {
   }
 
   /**
-   * Build the form
+   * Build the form object
    *
    * @var CRM_Core_Form $form
    *
@@ -202,7 +202,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon {
   }
 
   /**
-   * form rule
+   * Form rule
    *
    * @param array $fields    the input form values
    * @param array $dontCare
@@ -236,11 +236,11 @@ class CRM_Contact_Form_Task_PDFLetterCommon {
   }
 
   /**
-   * part of the post process which prepare and extract information from the template
+   * Part of the post process which prepare and extract information from the template
    *
    * @access protected
    *
-   * @param $form
+   * @param CRM_Core_Form $form
    *
    * @return array( $categories, $html_message, $messageToken, $returnProperties )
    */
@@ -311,11 +311,11 @@ class CRM_Contact_Form_Task_PDFLetterCommon {
   }
 
   /**
-   * process the form after the input has been submitted and validated
+   * Process the form after the input has been submitted and validated
    *
    * @access public
    *
-   * @param $form
+   * @param CRM_Core_Form $form
    *
    * @return void
    */
@@ -364,7 +364,7 @@ class CRM_Contact_Form_Task_PDFLetterCommon {
   }
 
   /**
-   * @param $form
+   * @param CRM_Core_Form $form
    * @param $html_message
    * @param $contactIds
    *