INFRA-132 - CRM/Custom - Convert single-line @param to multi-line
authorTim Otten <totten@civicrm.org>
Tue, 6 Jan 2015 19:41:07 +0000 (11:41 -0800)
committerTim Otten <totten@civicrm.org>
Tue, 6 Jan 2015 23:02:27 +0000 (15:02 -0800)
CRM/Custom/Form/Field.php
CRM/Custom/Form/Group.php
CRM/Custom/Form/Option.php
CRM/Custom/Import/Form/MapField.php
CRM/Custom/Import/Parser/Api.php
CRM/Custom/Page/Field.php
CRM/Custom/Page/Group.php
CRM/Custom/Page/Option.php

index 925463294ed7f811033b5ac933e6acc7c420056c..0af9ef704d943ddbed16be822fe7df5d35ccddc6 100644 (file)
@@ -555,7 +555,8 @@ class CRM_Custom_Form_Field extends CRM_Core_Form {
   /**
    * Global validation rules for the form
    *
-   * @param array $fields posted values of the form
+   * @param array $fields
+   *   Posted values of the form.
    *
    * @param $files
    * @param $self
index 43cb12da115e1dfff3dd6e6ff85aed90d802a271..4153d002c6b888fefc50815ecd60eb9cd88c88a3 100644 (file)
@@ -107,8 +107,10 @@ class CRM_Custom_Form_Group extends CRM_Core_Form {
   /**
    * Global form rule
    *
-   * @param array $fields the input form values
-   * @param array $files the uploaded files if any
+   * @param array $fields
+   *   The input form values.
+   * @param array $files
+   *   The uploaded files if any.
    * @param $self
    *
    *
@@ -521,7 +523,8 @@ class CRM_Custom_Form_Group extends CRM_Core_Form {
   /**
    * Return a formatted list of relationship name.
    *
-   * @param array $list array of relationship name.
+   * @param array $list
+   *   Array of relationship name.
    *
    * @return array of relationship name.
    */
index d26347d6e2c0cea5bb96ed4126ca95646a9e028d..ad68ce83015b47ec7e4203f6011447a21df00281 100644 (file)
@@ -239,7 +239,8 @@ class CRM_Custom_Form_Option extends CRM_Core_Form {
   /**
    * Global validation rules for the form
    *
-   * @param array $fields posted values of the form
+   * @param array $fields
+   *   Posted values of the form.
    *
    * @param $files
    * @param CRM_Core_Form $form
index 16ce5d40b83d843f61553703afa1d9007c40b378..eef135f9413a32db2610c618ccaf5db5476d8cdb 100644 (file)
@@ -57,7 +57,8 @@ class CRM_Custom_Import_Form_MapField extends CRM_Contact_Import_Form_MapField {
   /**
    * Global validation rules for the form
    *
-   * @param array $fields posted values of the form
+   * @param array $fields
+   *   Posted values of the form.
    *
    * @return array list of errors to be posted back to the form
    * @static
index 38994300e8b4d03cfe4487b0bb88c758e13546cc..3905d638ac58c80f1df48813cd7280aac2309bae 100644 (file)
@@ -51,7 +51,8 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser {
   /**
    * Handle the values in mapField mode
    *
-   * @param array $values the array of values belonging to this line
+   * @param array $values
+   *   The array of values belonging to this line.
    *
    * @return boolean
    */
@@ -62,7 +63,8 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser {
   /**
    * Handle the values in preview mode
    *
-   * @param array $values the array of values belonging to this line
+   * @param array $values
+   *   The array of values belonging to this line.
    *
    * @return boolean      the result of this processing
    */
@@ -71,7 +73,8 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser {
   }
 
   /**
-   * @param array $values the array of values belonging to this line
+   * @param array $values
+   *   The array of values belonging to this line.
    *
    * @return boolean      the result of this processing
    * It is called from both the preview & the import actions
@@ -121,8 +124,10 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser {
   /**
    * Handle the values in import mode
    *
-   * @param int $onDuplicate the code for what action to take on duplicates
-   * @param array $values the array of values belonging to this line
+   * @param int $onDuplicate
+   *   The code for what action to take on duplicates.
+   * @param array $values
+   *   The array of values belonging to this line.
    *
    * @return boolean      the result of this processing
    */
@@ -203,7 +208,8 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser {
   /**
    * Return the field ids and names (with groups) for import purpose.
    *
-   * @param int      $id     Custom group ID
+   * @param int $id
+   *   Custom group ID.
    *
    * @return array   $importableFields
    *
index 55a5f079feeddcdee0f59fc4aa8be1e556b521da..fdd68e57732ea9e270c9244b99886826f40f1601 100644 (file)
@@ -200,7 +200,8 @@ class CRM_Custom_Page_Field extends CRM_Core_Page {
    *
    * editing would involved modifying existing fields + adding data to new fields.
    *
-   * @param string  $action    the action to be invoked
+   * @param string $action
+   *   The action to be invoked.
    *
    * @return void
    */
@@ -302,7 +303,8 @@ class CRM_Custom_Page_Field extends CRM_Core_Page {
   /**
    * Preview custom field
    *
-   * @param int  $id    custom field id
+   * @param int $id
+   *   Custom field id.
    *
    * @return void
    */
index 0c2ba2510054a30ddce2b3821b22ead3fcac1868..8a9d732bfaceb2b0de1dbf6d657cbd54dd02a2e9 100644 (file)
@@ -155,8 +155,10 @@ class CRM_Custom_Page_Group extends CRM_Core_Page {
   /**
    * Edit custom group
    *
-   * @param int    $id       custom group id
-   * @param string $action   the action to be invoked
+   * @param int $id
+   *   Custom group id.
+   * @param string $action
+   *   The action to be invoked.
    *
    * @return void
    */
@@ -176,7 +178,8 @@ class CRM_Custom_Page_Group extends CRM_Core_Page {
   /**
    * Preview custom group
    *
-   * @param int $id custom group id
+   * @param int $id
+   *   Custom group id.
    *
    * @return void
    */
@@ -193,7 +196,8 @@ class CRM_Custom_Page_Group extends CRM_Core_Page {
   /**
    * Browse all custom data groups.
    *
-   * @param string $action   the action to be invoked
+   * @param string $action
+   *   The action to be invoked.
    *
    * @return void
    */
index 449285cad6bfa94fac398f41391ff981c4a40b96..04b4dfa163ec8f8d3b34d881298078ece840b7e7 100644 (file)
@@ -237,7 +237,8 @@ ORDER BY weight, label
    *
    * editing would involved modifying existing fields + adding data to new fields.
    *
-   * @param string  $action   the action to be invoked
+   * @param string $action
+   *   The action to be invoked.
    *
    * @return void
    */