From: Eileen McNaughton <eileen@fuzion.co.nz>
Date: Wed, 21 May 2014 09:38:01 +0000 (+1200)
Subject: add a few comment blocks
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=4319322bc2071c800e5aacdafc4672cec2a2a11f;p=civicrm-core.git

add a few comment blocks
---

diff --git a/CRM/Contact/Page/AJAX.php b/CRM/Contact/Page/AJAX.php
index 806486b5ee..f26e4acbf8 100644
--- a/CRM/Contact/Page/AJAX.php
+++ b/CRM/Contact/Page/AJAX.php
@@ -1024,6 +1024,11 @@ LIMIT {$offset}, {$rowCount}
     CRM_Utils_System::civiExit();
   }
 
+  /**
+   * @param $name
+   *
+   * @return string
+   */
   static function _convertToId($name) {
     if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
       $cId = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
diff --git a/CRM/Contact/Page/CustomSearch.php b/CRM/Contact/Page/CustomSearch.php
index 472c1879c0..814cc0d8e8 100644
--- a/CRM/Contact/Page/CustomSearch.php
+++ b/CRM/Contact/Page/CustomSearch.php
@@ -47,6 +47,9 @@ class CRM_Contact_Page_CustomSearch extends CRM_Core_Page {
    */
   static $_links = NULL;
 
+  /**
+   * @return array
+   */
   public static function &info() {
     $sql = "
 SELECT v.value, v.label, v.description
diff --git a/CRM/Contact/Page/DedupeRules.php b/CRM/Contact/Page/DedupeRules.php
index 501a45576f..13e38c458b 100644
--- a/CRM/Contact/Page/DedupeRules.php
+++ b/CRM/Contact/Page/DedupeRules.php
@@ -210,6 +210,9 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic {
     return 'civicrm/contact/deduperules';
   }
 
+  /**
+   * @param $id
+   */
   function delete($id) {
     $ruleDao = new CRM_Dedupe_DAO_Rule();
     $ruleDao->dedupe_rule_group_id = $id;
diff --git a/CRM/Contact/Page/View.php b/CRM/Contact/Page/View.php
index 82bc7cbdb7..d3be2d9b3d 100644
--- a/CRM/Contact/Page/View.php
+++ b/CRM/Contact/Page/View.php
@@ -276,6 +276,10 @@ class CRM_Contact_Page_View extends CRM_Core_Page {
     );
   }
 
+  /**
+   * @param $page
+   * @param null $contactID
+   */
   static function checkUserPermission($page, $contactID = NULL) {
     // check for permissions
     $page->_permission = NULL;
diff --git a/CRM/Contact/Page/View/Summary.php b/CRM/Contact/Page/View/Summary.php
index ee94b0173a..9db5155104 100644
--- a/CRM/Contact/Page/View/Summary.php
+++ b/CRM/Contact/Page/View/Summary.php
@@ -417,9 +417,12 @@ class CRM_Contact_Page_View_Summary extends CRM_Contact_Page_View {
     }
   }
 
+  /**
+   * @return string
+   */
   function getTemplateFileName() {
     if ($this->_contactId) {
-      $contactSubtypes = $this->get('contactSubtype') ? 
+      $contactSubtypes = $this->get('contactSubtype') ?
         explode(CRM_Core_DAO::VALUE_SEPARATOR, $this->get('contactSubtype')) : array();
 
       // there could be multiple subtypes. We check templates for each of the subtype, and return the first one found.
diff --git a/CRM/Contact/Page/View/UserDashBoard.php b/CRM/Contact/Page/View/UserDashBoard.php
index 135e70ddb1..93b4cce8ab 100644
--- a/CRM/Contact/Page/View/UserDashBoard.php
+++ b/CRM/Contact/Page/View/UserDashBoard.php
@@ -57,6 +57,9 @@ class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page {
    */
   static $_links = NULL;
 
+  /**
+   * @throws Exception
+   */
   function __construct() {
     parent::__construct();