comment fixes

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

diff --git a/CRM/Core/BAO/PaperSize.php b/CRM/Core/BAO/PaperSize.php
index 8a323498a6c5d35d6aea2bb13141fdab8937f883..439ef42cd09b5b68ba67c3a4422942bebe336cd0 100644 (file)
--- a/CRM/Core/BAO/PaperSize.php
+++ b/CRM/Core/BAO/PaperSize.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
  | Copyright (C) 2011 Marty Wright                                    |
  | Licensed to CiviCRM under the Academic Free License version 3.0.   |
@@ -24,23 +24,21 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
+ * @copyright CiviCRM LLC (c) 2004-2015
  */
 
 /**
- * This class contains functions for managing Paper Sizes
+ * This class contains functions for managing Paper Sizes.
  */
 class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
 
   /**
-   * Static holder for the Paper Size Option Group ID
+   * Static holder for the Paper Size Option Group ID.
    */
   private static $_gid = NULL;
 
@@ -68,9 +66,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   );
 
   /**
-   * Get Option Group ID for Paper Sizes
-   *
-   * @param void
+   * Get Option Group ID for Paper Sizes.
    *
    * @return int
    *   Group ID (null if Group ID doesn't exist)
@@ -86,14 +82,12 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Add ordering fields to Paper Size list
+   * Add ordering fields to Paper Size list.
    *
    * @param array (reference) $list List of Paper Sizes
    * @param string $returnURL
    *   URL of page calling this function.
    *
-   * @return array
-   *   (reference)   List of Paper Sizes
    */
   public static function &addOrder(&$list, $returnURL) {
     $filter = "option_group_id = " . self::_getGid();
@@ -131,9 +125,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Retrieve the default Paper Size values
-   *
-   * @param NULL
+   * Retrieve the default Paper Size values.
    *
    * @return array
    *   Name/value pairs containing the default Paper Size values.
@@ -152,7 +144,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get Paper Size from the DB
+   * Get Paper Size from the DB.
    *
    * @param string $field
    *   Field name to search by.
@@ -174,7 +166,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get Paper Size by Name
+   * Get Paper Size by Name.
    *
    * @param int $name
    *   Paper Size name. Empty = get default Paper Size.
@@ -187,7 +179,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get Paper Size by ID
+   * Get Paper Size by ID.
    *
    * @param int $id
    *   Paper Size id. 0 = get default Paper Size.
@@ -200,7 +192,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Get Paper Size field from associative array
+   * Get Paper Size field from associative array.
    *
    * @param string $field
    *   Name of a Paper Size field.
@@ -231,9 +223,9 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Takes a bunch of params that are needed to match certain criteria and
-   * retrieves the relevant objects. Typically the valid params are only
-   * paper size id. It also stores all the retrieved values in the default array.
+   * Retrieve DB object based on input parameters.
+   *
+   * It also stores all the retrieved values in the default array.
    *
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
@@ -269,13 +261,11 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Save the Paper Size in the DB
+   * 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).
-   *
-   * @return void
    */
   public function savePaperSize(&$values, $id) {
     // get the Option Group ID for Paper Sizes (create one if it doesn't exist)
@@ -329,7 +319,7 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
   }
 
   /**
-   * Delete a Paper Size
+   * Delete a Paper Size.
    *
    * @param int $id
    *   ID of the Paper Size to be deleted.
@@ -350,4 +340,5 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
     }
     CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
   }
+
 }