INFRA-132 - Comment grammar cleanup

[civicrm-core.git] / CRM / Core / BAO / PaperSize.php

diff --git a/CRM/Core/BAO/PaperSize.php b/CRM/Core/BAO/PaperSize.php
index 796b9074c161a41624f6d58f7149c0f685bc5538..bfce94cdb8ce4960fb13c70525c81c0f09bea08e 100644 (file)
--- a/CRM/Core/BAO/PaperSize.php
+++ b/CRM/Core/BAO/PaperSize.php
@@ -87,8 +87,9 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Add ordering fields to Paper Size list
    *
-   * @param array (reference)   $list         List of Paper Sizes
-   * @param string              $returnURL    URL of page calling this function
+   * @param array (reference) $list List of Paper Sizes
+   * @param string $returnURL
+   *   URL of page calling this function.
    *
    * @return array  (reference)   List of Paper Sizes
    * @static
@@ -101,7 +102,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Retrieve list of Paper Sizes.
    *
-   * @param bool    $namesOnly    return simple list of names
+   * @param bool $namesOnly
+   *   Return simple list of names.
    *
    * @return array  (reference)   Paper Size list
    * @static
@@ -151,8 +153,10 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Get Paper Size from the DB
    *
-   * @param string $field   Field name to search by
-   * @param int    $val     Field value to search for
+   * @param string $field
+   *   Field name to search by.
+   * @param int $val
+   *   Field value to search for.
    *
    * @return array  $values (reference) associative array of name/value pairs
    */
@@ -170,7 +174,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Get Paper Size by Name
    *
-   * @param int    $name   Paper Size name. Empty = get default Paper Size
+   * @param int $name
+   *   Paper Size name. Empty = get default Paper Size.
    *
    * @return array  $values (reference) associative array of name/value pairs
    */
@@ -181,7 +186,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Get Paper Size by ID
    *
-   * @param int    $id   Paper Size id. 0 = get default Paper Size
+   * @param int $id
+   *   Paper Size id. 0 = get default Paper Size.
    *
    * @return array  $values (reference) associative array of name/value pairs
    */
@@ -192,7 +198,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Get Paper Size field from associative array
    *
-   * @param string $field name of a Paper Size field
+   * @param string $field
+   *   Name of a Paper Size field.
    * @param array (reference) $values associative array of name/value pairs containing
    *                                           Paper Size field selections
    *
@@ -225,8 +232,10 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
    * retrieves the relevant objects. Typically the valid params are only
    * paper size id. It also stores all the retrieved values in the default array.
    *
-   * @param array $params   (reference ) an assoc array of name/value pairs
-   * @param array $values   (reference ) an assoc array to hold the flattened values
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
+   * @param array $values
+   *   (reference ) an assoc array to hold the flattened values.
    *
    * @return CRM_Core_DAO_OptionValue object
    * @static
@@ -260,8 +269,9 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Save the Paper Size in the DB
    *
-   * @param array (reference)   $values    associative array of name/value pairs
-   * @param int                 $id        id of the database record (null = new record)
+   * @param array (reference) $values associative array of name/value pairs
+   * @param int $id
+   *   Id of the database record (null = new record).
    *
    * @return void
    */
@@ -319,7 +329,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   /**
    * Delete a Paper Size
    *
-   * @param  int  $id     ID of the Paper Size to be deleted.
+   * @param int $id
+   *   ID of the Paper Size to be deleted.
    *
    * @static
    */