CRM-15180 - https://issues.civicrm.org/jira/browse/CRM-15180

[civicrm-core.git] / CRM / Core / OptionValue.php

diff --git a/CRM/Core/OptionValue.php b/CRM/Core/OptionValue.php
index 1d7cf7fda12e098423ef17fa9e03d14a06d280c8..3a886d74acf23d58c1215ff10be1a80966a02826 100644 (file)
--- a/CRM/Core/OptionValue.php
+++ b/CRM/Core/OptionValue.php
@@ -35,7 +35,7 @@
 class CRM_Core_OptionValue {
 
   /**
-   * static field for all the option value information that we can potentially export
+   * Static field for all the option value information that we can potentially export
    *
    * @var array
    * @static
@@ -43,7 +43,7 @@ class CRM_Core_OptionValue {
   static $_exportableFields = NULL;
 
   /**
-   * static field for all the option value information that we can potentially export
+   * Static field for all the option value information that we can potentially export
    *
    * @var array
    * @static
@@ -51,7 +51,7 @@ class CRM_Core_OptionValue {
   static $_importableFields = NULL;
 
   /**
-   * static field for all the option value information that we can potentially export
+   * Static field for all the option value information that we can potentially export
    *
    * @var array
    * @static
@@ -59,7 +59,7 @@ class CRM_Core_OptionValue {
   static $_fields = NULL;
 
   /**
-   * Function to return option-values of a particular group
+   * Return option-values of a particular group
    *
    * @param  array     $groupParams   Array containing group fields whose option-values is to retrieved.
    * @param  string    $orderBy       for orderBy clause
@@ -170,14 +170,13 @@ class CRM_Core_OptionValue {
   }
 
   /**
-   * Function to add/edit option-value of a particular group
+   * Add/edit option-value of a particular group
    *
    * @param  array $params Array containing exported values from the invoking form.
    * @param  array $groupParams Array containing group fields whose option-values is to retrieved/saved.
    * @param $action
    * @param  integer $optionValueID has the id of the optionValue being edited, disabled ..etc
    *
-   * @internal param string $orderBy for orderBy clause
    * @return CRM_Core_DAO_OptionValue
    *
    * @access public
@@ -244,7 +243,7 @@ class CRM_Core_OptionValue {
    * @param string $daoName the dao object name
    * @param string $daoID the id of the object being updated. u can change your name
    *                          as long as there is no conflict
-   * @param $optionGroupID
+   * @param int $optionGroupID
    * @param string $fieldName the name of the field in the DAO
    *
    * @return boolean     true if object exists
@@ -270,12 +269,6 @@ class CRM_Core_OptionValue {
    * @param string $mode
    * @param string $contactType
    *
-   * @internal param string $value the value of the field we are checking
-   * @internal param string $daoName the dao object name
-   * @internal param string $daoID the id of the object being updated. u can change your name
-   *                          as long as there is no conflict
-   * @internal param string $fieldName the name of the field in the DAO
-   *
    * @return boolean     true if object exists
    * @access public
    * @static
@@ -345,7 +338,7 @@ class CRM_Core_OptionValue {
   }
 
   /**
-   * build select query in case of option-values
+   * Build select query in case of option-values
    *
    * @param $query
    *
@@ -372,7 +365,7 @@ class CRM_Core_OptionValue {
   }
 
   /**
-   * Function to return option-values of a particular group
+   * Return option-values of a particular group
    *
    * @param  array     $groupParams   Array containing group fields
    *                                  whose option-values is to retrieved.