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

diff --git a/CRM/UF/Form/AbstractPreview.php b/CRM/UF/Form/AbstractPreview.php
index 966c897df34f6bd15605b6f1a39b9e8adfc4d89d..62f5a52caf733439c3dd69de54cdca7b1ea1d8c9 100644 (file)
--- a/CRM/UF/Form/AbstractPreview.php
+++ b/CRM/UF/Form/AbstractPreview.php
@@ -50,7 +50,8 @@ class CRM_UF_Form_AbstractPreview extends CRM_Core_Form {
   /**
    * Set the profile/field structure for this form
    *
-   * @param array $fields list of fields per CRM_Core_BAO_UFGroup::formatUFFields or CRM_Core_BAO_UFGroup::getFields
+   * @param array $fields
+   *   List of fields per CRM_Core_BAO_UFGroup::formatUFFields or CRM_Core_BAO_UFGroup::getFields.
    * @param bool $isSingleField
    * @param bool $flag
    */

diff --git a/CRM/UF/Form/Field.php b/CRM/UF/Form/Field.php
index 60802120887f7b236fba3efba9fd8e8d77dbcbcb..d26a6848e7d867ca057548f25dfa6ee0428c4150 100644 (file)
--- a/CRM/UF/Form/Field.php
+++ b/CRM/UF/Form/Field.php
@@ -609,9 +609,11 @@ class CRM_UF_Form_Field extends CRM_Core_Form {
   /**
    * Validation rule for subtype.
    *
-   * @param array $groupType contains all groupTypes.
+   * @param array $groupType
+   *   Contains all groupTypes.
    *
-   * @param  string  $fieldType type of field.
+   * @param string $fieldType
+   *   Type of field.
    *
    * @param array $errors
    *
@@ -652,10 +654,14 @@ class CRM_UF_Form_Field extends CRM_Core_Form {
   /**
    * Validation rule for custom data extends entity column values.
    *
-   * @param Object  $customField Custom field
-   * @param Integer $gid         Group Id.
-   * @param String  $fieldType   Group type of the field
-   * @param Array   $errors      Collect errors
+   * @param Object $customField
+   *   Custom field.
+   * @param int $gid
+   *   Group Id.
+   * @param string $fieldType
+   *   Group type of the field.
+   * @param array $errors
+   *   Collect errors.
    *
    * @return Array  list of errors to be posted back to the form
    * @static
@@ -697,10 +703,14 @@ class CRM_UF_Form_Field extends CRM_Core_Form {
   /**
    * Validation rule to prevent multiple fields of primary location type within the same communication type.
    *
-   * @param Array   $fields            Submitted fields
-   * @param String  $profileFieldName  Group Id.
-   * @param Array   $groupFields       List of fields already in the group
-   * @param Array   $errors            Collect errors
+   * @param array $fields
+   *   Submitted fields.
+   * @param string $profileFieldName
+   *   Group Id.
+   * @param array $groupFields
+   *   List of fields already in the group.
+   * @param array $errors
+   *   Collect errors.
    *
    * @static
    */
@@ -735,7 +745,8 @@ class CRM_UF_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

diff --git a/CRM/UF/Form/Group.php b/CRM/UF/Form/Group.php
index 5a6e4ef7ece6952ec6c64ae912ec6cc46c50ce16..bd992d50da6338e996dd23030da90bbcd615db36 100644 (file)
--- a/CRM/UF/Form/Group.php
+++ b/CRM/UF/Form/Group.php
@@ -281,9 +281,12 @@ class CRM_UF_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 $self    current form object.
+   * @param array $fields
+   *   The input form values.
+   * @param array $files
+   *   The uploaded files if any.
+   * @param array $self
+   *   Current form object.
    *
    * @return true if no errors, else array of errors
    * @static

diff --git a/CRM/UF/Page/Field.php b/CRM/UF/Page/Field.php
index 2caeddf47ccdabd466291b4e32910d918882c6b8..4f65ef5b375506f5af9be747da4f3d72c5760f50 100644 (file)
--- a/CRM/UF/Page/Field.php
+++ b/CRM/UF/Page/Field.php
@@ -206,7 +206,8 @@ class CRM_UF_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
    */
@@ -279,7 +280,8 @@ class CRM_UF_Page_Field extends CRM_Core_Page {
   /**
    * Preview custom field
    *
-   * @param int $fieldId custom field id
+   * @param int $fieldId
+   *   Custom field id.
    * @param int $groupId
    *
    * @return void

diff --git a/CRM/UF/Page/Group.php b/CRM/UF/Page/Group.php
index b6dbcd6331f335d9dc1d900adaf0fe5f3b3ee31b..d903f3df5363fc6678b3c5e07e938719c253b1ff 100644 (file)
--- a/CRM/UF/Page/Group.php
+++ b/CRM/UF/Page/Group.php
@@ -268,8 +268,10 @@ class CRM_UF_Page_Group extends CRM_Core_Page {
   /**
    * Edit uf group
    *
-   * @param int $id uf group id
-   * @param string $action the action to be invoked
+   * @param int $id
+   *   Uf group id.
+   * @param string $action
+   *   The action to be invoked.
    *
    * @return void
    */
@@ -380,7 +382,8 @@ class CRM_UF_Page_Group extends CRM_Core_Page {
   /**
    * This function is for preview mode for ufoup
    *
-   * @param int $id uf group id
+   * @param int $id
+   *   Uf group id.
    *
    * @param $action
    *

diff --git a/CRM/UF/Page/ProfileEditor.php b/CRM/UF/Page/ProfileEditor.php
index 4537567619afab874545377cbf715ff2859b73be..c6656c29e4c7bd65df86739c988f21e0ceeb6188 100644 (file)
--- a/CRM/UF/Page/ProfileEditor.php
+++ b/CRM/UF/Page/ProfileEditor.php
@@ -64,7 +64,8 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
   /**
    * Register entity schemas for use in the editor's palette
    *
-   * @param array $entityTypes strings, e.g. "IndividualModel", "ActivityModel"
+   * @param array $entityTypes
+   *   Strings, e.g. "IndividualModel", "ActivityModel".
    */
   public static function registerSchemas($entityTypes) {
     // TODO in cases where registerSchemas is called multiple times for same entity, be more efficient
@@ -86,7 +87,8 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
   /**
    * Get a list of Backbone-Form models
    *
-   * @param array $entityTypes model names ("IndividualModel")
+   * @param array $entityTypes
+   *   Model names ("IndividualModel").
    *
    * @throws CRM_Core_Exception
    * @return array; keys are model names ("IndividualModel") and values describe 'sections' and 'schema'
@@ -173,9 +175,12 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
    * FIXME: Move to somewhere more useful
    * FIXME: Do real mapping of "types"
    *
-   * @param string $extends entity type; note: "Individual" means "Individual|Contact"; "Household" means "Household|Contact"
-   * @param string $title a string to use in section headers
-   * @param array $availableFields list of fields that are allowed in profiles, e.g. $availableFields['my_field']['field_type']
+   * @param string $extends
+   *   Entity type; note: "Individual" means "Individual|Contact"; "Household" means "Household|Contact".
+   * @param string $title
+   *   A string to use in section headers.
+   * @param array $availableFields
+   *   List of fields that are allowed in profiles, e.g. $availableFields['my_field']['field_type'].
    * @return array with keys 'sections' and 'schema'
    * @see js/model/crm.core.js
    * @see js/model/crm.mappedcore.js