some random comment fixes

diff --git a/CRM/ACL/BAO/ACL.php b/CRM/ACL/BAO/ACL.php
index 1277fe4c9ed4039f61611dd6dbda9e7022b2b4cd..9fd37f5ba06f0f71b364aea652dbfe5b9a342fa0 100644 (file)
--- a/CRM/ACL/BAO/ACL.php
+++ b/CRM/ACL/BAO/ACL.php
@@ -35,6 +35,9 @@
  *  Access Control List
  */
 class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL {
+  /**
+   * @var string
+   */
   static $_entityTable = NULL;
   static $_objectTable = NULL;
   static $_operation = NULL;

diff --git a/CRM/Badge/BAO/Badge.php b/CRM/Badge/BAO/Badge.php
index 6c2da90afd263612d1514c7ab5538682e7a8e454..ccd71675082d86ebe94189e9a7d7cf2a0dc671a8 100644 (file)
--- a/CRM/Badge/BAO/Badge.php
+++ b/CRM/Badge/BAO/Badge.php
@@ -36,8 +36,14 @@
  */
 class CRM_Badge_BAO_Badge {
 
+  /**
+   * @var bool
+   */
   public $debug = FALSE;
 
+  /**
+   * @var int
+   */
   public $border = 0;
 
   /**

diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php
index eaec754c7009f1ed18e62d2864925f8d2aa63996..90f470cfffc3a619ef4cf6b70289a22bfb799483 100644 (file)
--- a/CRM/Contact/BAO/ContactType.php
+++ b/CRM/Contact/BAO/ContactType.php
@@ -54,7 +54,9 @@ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType {
   }
 
   /**
-   * @param $contactType
+   * Is this contact type active.
+   *
+   * @param string $contactType
    *
    * @return bool
    */
@@ -266,8 +268,7 @@ WHERE  subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE}
   }
 
   /**
-   *
-   * retrieve info array about all types i.e basic + subtypes.
+   * Retrieve info array about all types i.e basic + subtypes.
    *
    * @param bool $all
    * @param bool $reset
@@ -326,7 +327,7 @@ WHERE  type.name IS NOT NULL
   }
 
   /**
-   * Retrieve basic type pairs with name as 'built-in name' and 'label' as value
+   * Retrieve basic type pairs with name as 'built-in name' and 'label' as value.
    *
    * @param bool $all
    * @param null $typeName

diff --git a/CRM/Core/BAO/SchemaHandler.php b/CRM/Core/BAO/SchemaHandler.php
index 8b1a16d5d3fe03ee31cab10194148137d5932361..f27648762a335623d55742e6f901c7a14dae1d71 100644 (file)
--- a/CRM/Core/BAO/SchemaHandler.php
+++ b/CRM/Core/BAO/SchemaHandler.php
@@ -29,35 +29,29 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
- */
-
-/**
- *  This file contains functions for creating and altering CiviCRM-tables.
  */
 
 /**
- * structure, similar to what is used in GenCode.php
+ *  This file contains functions for creating and altering CiviCRM-tables structure.
  *
  * $table = array(
- * 'name'       => TABLE_NAME,
- *                'attributes' => ATTRIBUTES,
- *                'fields'     => array(
- *                                      array(
- * 'name'          => FIELD_NAME,
- *                                             'type'          => FIELD_SQL_TYPE,
- * // can be field, index, constraint
- *                                             'class'         => FIELD_CLASS_TYPE,
- *                                             'primary'       => BOOLEAN,
- *                                             'required'      => BOOLEAN,
- *                                             'searchable'    => TRUE,
- *                                             'fk_table_name' => FOREIGN_KEY_TABLE_NAME,
- *                                             'fk_field_name' => FOREIGN_KEY_FIELD_NAME,
- *                                             'comment'       => COMMENT,
- *                                             'default'       => DEFAULT, )
- *                                      ...
- *                                      ) );
+ *  'name'  => TABLE_NAME,
+ *  'attributes' => ATTRIBUTES,
+ *  'fields' => array(
+ *    array(
+ *      'name' => FIELD_NAME,
+ *      // can be field, index, constraint
+ *      'type' => FIELD_SQL_TYPE,
+ *      'class'         => FIELD_CLASS_TYPE,
+ *      'primary'       => BOOLEAN,
+ *      'required'      => BOOLEAN,
+ *      'searchable'    => TRUE,
+ *      'fk_table_name' => FOREIGN_KEY_TABLE_NAME,
+ *      'fk_field_name' => FOREIGN_KEY_FIELD_NAME,
+ *      'comment'       => COMMENT,
+ *      'default'       => DEFAULT, )
+ *      ...
+ *  ));
  */
 class CRM_Core_BAO_SchemaHandler {
 

diff --git a/CRM/Cxn/CiviCxnStore.php b/CRM/Cxn/CiviCxnStore.php
index eb05f86119fe47499d67c03784d81950df82385b..dc25dc8c51ba22b9f698308233e8c45e1d930b66 100644 (file)
--- a/CRM/Cxn/CiviCxnStore.php
+++ b/CRM/Cxn/CiviCxnStore.php
@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * Class CRM_Cxn_CiviCxnStore
+ */
 class CRM_Cxn_CiviCxnStore implements Civi\Cxn\Rpc\CxnStore\CxnStoreInterface {
 
   protected $cxns = array();

diff --git a/CRM/Event/Cart/Page/AddToCart.php b/CRM/Event/Cart/Page/AddToCart.php
index e4f95eb807600f36409d007469934c598c280fc4..045d77dbc7ea394df5d55e17dc0dafd316c9bc00 100644 (file)
--- a/CRM/Event/Cart/Page/AddToCart.php
+++ b/CRM/Event/Cart/Page/AddToCart.php
@@ -4,6 +4,11 @@
  * Class CRM_Event_Cart_Page_AddToCart
  */
 class CRM_Event_Cart_Page_AddToCart extends CRM_Core_Page {
+  /**
+   * This function takes care of all the things common to all pages.
+   *
+   * This typically involves assigning the appropriate smarty variables :)
+   */
   public function run() {
     $transaction = new CRM_Core_Transaction();
 

diff --git a/CRM/Event/Cart/Page/RemoveFromCart.php b/CRM/Event/Cart/Page/RemoveFromCart.php
index a52e84140352895df4603553630abe69390785fc..b9d7efbec483d1651d9db35b2d2cf0009264af5a 100644 (file)
--- a/CRM/Event/Cart/Page/RemoveFromCart.php
+++ b/CRM/Event/Cart/Page/RemoveFromCart.php
@@ -4,6 +4,11 @@
  * Class CRM_Event_Cart_Page_RemoveFromCart
  */
 class CRM_Event_Cart_Page_RemoveFromCart extends CRM_Core_Page {
+  /**
+   * This function takes care of all the things common to all pages.
+   *
+   * This typically involves assigning the appropriate smarty variables :)
+   */
   public function run() {
     $transaction = new CRM_Core_Transaction();
     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);

diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php
index 7c3eff86f547a65e336ebb701a763ed55edf1364..4fcf26f6e10d9e2a471570e8f41f480f62f0dafa 100644 (file)
--- a/CRM/Mailing/BAO/Mailing.php
+++ b/CRM/Mailing/BAO/Mailing.php
@@ -1403,7 +1403,7 @@ ORDER BY   civicrm_email.is_bulkmail DESC
    *
    * Get mailing object and replaces subscribeInvite, domain and mailing tokens.
    *
-   * @param array $mailing
+   * @param CRM_Mailing_BAO_Mailing $mailing
    */
   public static function tokenReplace(&$mailing) {
     $domain = CRM_Core_BAO_Domain::getDomain();

diff --git a/Civi/ActionSchedule/MappingInterface.php b/Civi/ActionSchedule/MappingInterface.php
index cbee54781cb187e0f772b0c55887292f3105b799..4e4403efb4f2cc562cf636bb368e8b53c083827b 100644 (file)
--- a/Civi/ActionSchedule/MappingInterface.php
+++ b/Civi/ActionSchedule/MappingInterface.php
@@ -27,6 +27,10 @@
 
 namespace Civi\ActionSchedule;
 
+/**
+ * Interface MappingInterface
+ * @package Civi\ActionSchedule
+ */
 interface MappingInterface {
 
   /**

diff --git a/api/v3/System.php b/api/v3/System.php
index 712d80e2310c8060d523f9982b82a5384cf7f046..b7514c5a0682b46c479bffa742770247e11ca818 100644 (file)
--- a/api/v3/System.php
+++ b/api/v3/System.php
@@ -348,6 +348,12 @@ function _civicrm_api3_system_get_redacted_mysql() {
   return $result;
 }
 
+/**
+ * Get redacted settings.
+ *
+ * @return array
+ * @throws CiviCRM_API3_Exception
+ */
 function _civicrm_api3_system_get_redacted_settings() {
   static $whitelist = NULL;
   if ($whitelist === NULL) {