Cleanup phpdoc comments

[civicrm-core.git] / CRM / Utils / System / Soap.php

diff --git a/CRM/Utils/System/Soap.php b/CRM/Utils/System/Soap.php
index c8d2c24704ae8a6437e8962912014f2fbd1fe5ba..05e804f7ea5948b2fbb6b28638496d24526595b2 100644 (file)
--- a/CRM/Utils/System/Soap.php
+++ b/CRM/Utils/System/Soap.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.3                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -45,9 +45,11 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base {
   static $ufClass = NULL;
 
   /**
-   * sets the title of the page
+   * Sets the title of the page
    *
    * @param string $title title  for page
+   * @param $pageTitle
+   *
    * @paqram string $pageTitle
    *
    * @return void
@@ -58,7 +60,7 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base {
   }
 
   /**
-   * given a permission string, check for access requirements
+   * Given a permission string, check for access requirements
    *
    * @param string $str the permission to check
    *
@@ -121,7 +123,7 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base {
   }
 
   /**
-   * figure out the post url for the form
+   * Figure out the post url for the form
    *
    * @param the default action if one is pre-specified
    *
@@ -133,7 +135,7 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base {
   }
 
   /**
-   * Function to set the email address of the user
+   * Set the email address of the user
    *
    * @param object $user handle to the user object
    *
@@ -191,6 +193,7 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base {
    *
    * @param string $destination - if present, add destination to querystring (works for Drupal only)
    *
+   * @throws Exception
    * @return string - loginURL for the current CMS
    * @static
    */