INFRA-132 - CRM/Report - Convert single-line @param to multi-line

diff --git a/CRM/Report/BAO/ReportInstance.php b/CRM/Report/BAO/ReportInstance.php
index 271248870b56b34e82709e6e82222d44b6d00167..2c922ec227432c2a4474b227ff92c79dfd1e5376 100644 (file)
--- a/CRM/Report/BAO/ReportInstance.php
+++ b/CRM/Report/BAO/ReportInstance.php
@@ -42,7 +42,8 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance {
    * instance object. the params array could contain additional unused name/value
    * pairs
    *
-   * @param array  $params (reference ) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
    *
    * @return CRM_Report_DAO_ReportInstance object
    * @static
@@ -122,7 +123,8 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance {
    *
    * This function is invoked from within the web form layer and also from the api layer
    *
-   * @param array   $params      (reference ) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
    *
    * @return CRM_Report_BAO_ReportInstance object
    * @static

diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php
index 9b0dbb4fd2902dba7601f0a9f5922da1367399af..506fb6cc61e1bc6276d24aad7e56b3d2b0634029 100644 (file)
--- a/CRM/Report/Form.php
+++ b/CRM/Report/Form.php
@@ -1626,8 +1626,8 @@ class CRM_Report_Form extends CRM_Core_Form {
    * @todo - could not find any instances where this is called
    *
    * @param unknown_type $relative
-   * @param String $from
-   * @param String_type $to
+   * @param string $from
+   * @param string_type $to
    *
    * @return string|NULL
    */
@@ -3533,7 +3533,8 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a
   /**
    * Does table name have columns in SELECT clause?
    *
-   * @param string $tableName Name of table (index of $this->_columns array)
+   * @param string $tableName
+   *   Name of table (index of $this->_columns array).
    *
    * @return bool
    */
@@ -3601,8 +3602,10 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a
    *
    * adding address fields to construct function in reports
    *
-   * @param bool $groupBy Add GroupBy? Not appropriate for detail report
-   * @param bool $orderBy Add GroupBy? Not appropriate for detail report
+   * @param bool $groupBy
+   *   Add GroupBy? Not appropriate for detail report.
+   * @param bool $orderBy
+   *   Add GroupBy? Not appropriate for detail report.
    * @param bool $filters
    * @param array $defaults
    *

diff --git a/CRM/Report/Form/Extended.php b/CRM/Report/Form/Extended.php
index e6adeb95277d8ec63062c24109a8c8721cce658e..851b65debe086c42a92c79298e26025aa5460199 100644 (file)
--- a/CRM/Report/Form/Extended.php
+++ b/CRM/Report/Form/Extended.php
@@ -698,7 +698,8 @@ class CRM_Report_Form_Extended extends CRM_Report_Form {
 
   /*
    * adding address fields to construct function in reports
-   * @param array $options Options for the report
+   * @param array $options
+   *   Options for the report.
    * - prefix prefix to add (e.g. 'honor' when getting address details for honor contact
    * - prefix_label optional prefix lable eg. "Honoree " for front end
    * - group_by enable these fields for group by - default false

diff --git a/CRM/Report/Page/Options.php b/CRM/Report/Page/Options.php
index a603e1c8fdfd0f8d660c4c792dc1fde3b8a1019d..37dfde714de17b91dd083c72009531e743f08922 100644 (file)
--- a/CRM/Report/Page/Options.php
+++ b/CRM/Report/Page/Options.php
@@ -213,7 +213,8 @@ class CRM_Report_Page_Options extends CRM_Core_Page_Basic {
   /**
    * Get userContext params
    *
-   * @param int $mode mode that we are in
+   * @param int $mode
+   *   Mode that we are in.
    *
    * @return string
    */

diff --git a/CRM/Report/Utils/Report.php b/CRM/Report/Utils/Report.php
index 23e364e6958650c7170db782ddec922062c70360..62de36c2b2dee56dc090387f24c2b4907e52f1cd 100644 (file)
--- a/CRM/Report/Utils/Report.php
+++ b/CRM/Report/Utils/Report.php
@@ -456,8 +456,10 @@ WHERE  inst.report_id = %1";
    * stipulated in $_GET or in a report Preview, but which haven't yet been
    * saved in the report instance.
    *
-   * @param array $defaults The report criteria that aren't coming in as submitted form values, as in CRM_Report_Form::_defaults
-   * @param array $params All effective report criteria, as in CRM_Report_Form::_params
+   * @param array $defaults
+   *   The report criteria that aren't coming in as submitted form values, as in CRM_Report_Form::_defaults.
+   * @param array $params
+   *   All effective report criteria, as in CRM_Report_Form::_params.
    *
    * @return string URL query string
    */